> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upriver.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Product Details

> Provides details for a specific product including description, features, and pricing. Provide as much information as you have — more context improves accuracy.

**Input:**
- **product_name**: Required.
- **product_url**, **brand_url**, **brand_name**: Optional. At least one required to identify the brand.

**Effort Levels:**
- **low**: fast extraction from the product page.
- **high**: includes competitive research (alternatives).



## OpenAPI

````yaml /api-reference/openapi.json post /v1/brand/product
openapi: 3.1.0
info:
  title: Upriver API
  description: >-
    A social insights API for ad generation platforms. It provides structured
    signals, like psychographics, behavioral insights, trends, and audience
    language, to help AI models generate relevant, higher-converting ads.
  version: 1.0.0
servers:
  - url: https://api.upriver.ai
    description: Production API server
security: []
tags:
  - name: Brands
  - name: Products
  - name: Creators
  - name: Audience
  - name: Sponsorships
  - name: Trends
  - name: Breakout Topics
  - name: Taxonomy
paths:
  /v1/brand/product:
    post:
      tags:
        - Products
      summary: Product Details
      description: >-
        Provides details for a specific product including description, features,
        and pricing. Provide as much information as you have — more context
        improves accuracy.


        **Input:**

        - **product_name**: Required.

        - **product_url**, **brand_url**, **brand_name**: Optional. At least one
        required to identify the brand.


        **Effort Levels:**

        - **low**: fast extraction from the product page.

        - **high**: includes competitive research (alternatives).
      operationId: brand_product_detail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandProductDetailInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandProductDetailResponse'
        '404':
          description: No results found for the given brand or product.
          content:
            application/json:
              example:
                detail: No products found on https://example.com
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    BrandProductDetailInput:
      properties:
        brand_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Url
          description: The brand's website URL.
          example: https://glossier.com
        brand_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Name
          description: >-
            Deprecated — brand name is now resolved automatically from the URL.
            This field is accepted but ignored.
          deprecated: true
        product_name:
          type: string
          title: Product Name
          description: The name of the product to research.
          example: Boy Brow
        product_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Product Url
          description: The product page URL.
          example: https://www.glossier.com/products/boy-brow
        effort:
          $ref: '#/components/schemas/EffortLevel'
          description: >-
            Effort level: 'low' (basic details), 'high' (includes competitive
            info)
          default: low
          example: low
      type: object
      required:
        - product_name
      title: BrandProductDetailInput
      description: Input model for detailed product research endpoint.
    BrandProductDetailResponse:
      properties:
        name:
          type: string
          title: Name
          description: Official product name
          example: Boy Brow
        description:
          type: string
          title: Description
          description: Detailed product description
          example: >-
            A brushable, buildable brow gel that thickens and shapes brows.
            Available in 5 shades, Boy Brow uses a short bristle brush to
            deposit a flexible, buildable hold formula.
        features:
          items:
            type: string
          type: array
          title: Features
          description: Key features
          example:
            - Flexible, buildable hold
            - Short bristle brush for precise application
            - Available in 5 shades
            - Conditioning formula with cellulose and oleic acid
        specifications:
          additionalProperties:
            type: string
          type: object
          title: Specifications
          description: Technical specifications
          example:
            shades: Blond, Brown, Black, Auburn, Clear
            size: 3.12 g / 0.11 oz
            type: Brow gel
        price:
          anyOf:
            - type: string
            - type: 'null'
          title: Price
          description: Price information
          example: $18.00
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
          description: Currency code
          example: USD
        reviews_summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Reviews Summary
          description: Summary of reviews
          example: >-
            4.5 stars from 3,200+ reviews. Customers love the natural look and
            easy application.
        alternatives:
          items:
            type: string
          type: array
          title: Alternatives
          description: Alternative products (high effort only)
          example:
            - Benefit Gimme Brow+
            - NYX Thick It Stick It Brow Gel
        images:
          items:
            type: string
          type: array
          title: Images
          description: Product images
          example:
            - https://www.glossier.com/cdn/images/boy-brow-brown.jpg
      type: object
      required:
        - name
        - description
      title: BrandProductDetailResponse
      description: Response model for detailed product research.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EffortLevel:
      type: string
      enum:
        - auto
        - low
        - mid
        - high
      title: EffortLevel
      description: Effort level for product research.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````