> ## 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.

# Brand Research

> Provides details for a brand including identity, target audience, and brand language. Returns structured data optimized for chaining into the Audience Insights endpoint.

**Input Options:**
- Provide `brand_name` and/or `brand_url`



## OpenAPI

````yaml /api-reference/openapi.json post /v1/brand/research
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/research:
    post:
      tags:
        - Brands
      summary: Brand Research
      description: >-
        Provides details for a brand including identity, target audience, and
        brand language. Returns structured data optimized for chaining into the
        Audience Insights endpoint.


        **Input Options:**

        - Provide `brand_name` and/or `brand_url`
      operationId: brand_research
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandV2Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    BrandInput:
      properties:
        brand_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Url
          description: The brand website URL to research
          example: https://example.com
        brand_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Name
          description: The brand name to research
          example: Example Brand
        response_format:
          $ref: '#/components/schemas/apis__models__brand__ResponseFormat'
          description: >-
            Format for the response: 'json' for structured data, 'text' for
            natural language
          default: json
          example: json
        effort:
          $ref: '#/components/schemas/BrandResearchEffort'
          description: >-
            Effort level for brand research. 'auto' selects the appropriate
            level (currently defaults to 'low').
          default: auto
          example: auto
        include:
          items:
            type: string
          type: array
          title: Include
          description: >-
            Optional list of extra data to include in the response. Supported
            values: 'colors'. When 'colors' is included, brand colors are
            extracted from the website CSS and logos.
          default: []
          example:
            - colors
      type: object
      title: BrandInput
      description: Input model for brand research endpoint.
      example:
        brand_url: https://www.bose.com
    BrandV2Response:
      properties:
        brand:
          $ref: '#/components/schemas/BrandV2Brand'
          description: Brand information
        industries:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Industries
          description: Industry labels
        audience:
          anyOf:
            - $ref: '#/components/schemas/BrandV2Audience'
            - type: 'null'
          description: Target audience summary
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: Provenance and supporting evidence
        effort:
          anyOf:
            - $ref: '#/components/schemas/BrandResearchEffort'
            - type: 'null'
          description: >-
            Effort level used to generate this result. 'auto' is resolved to the
            actual level applied.
      type: object
      required:
        - brand
      title: BrandV2Response
      description: Response model for the v2 brand research endpoint.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    apis__models__brand__ResponseFormat:
      type: string
      enum:
        - json
        - text
      title: ResponseFormat
      description: Response format options for brand research.
    BrandResearchEffort:
      type: string
      enum:
        - auto
        - low
        - mid
        - high
      title: BrandResearchEffort
      description: Effort level for brand research.
    BrandV2Brand:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Brand name
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: Brand website URL
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Concise summary of what the brand/company is and does
        identity:
          anyOf:
            - $ref: '#/components/schemas/BrandV2Identity'
            - type: 'null'
          description: Structured identity details
        colors:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Colors
          description: Brand color palette (primary/secondary/etc.)
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
          description: Additional notes or caveats from brand research
      type: object
      title: BrandV2Brand
      description: Brand object for the v2 brand research endpoint.
    BrandV2Audience:
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Narrative description of the target audience
      type: object
      title: BrandV2Audience
      description: Audience summary returned by /v2/brand.
    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
    BrandV2Identity:
      properties:
        mission:
          anyOf:
            - type: string
            - type: 'null'
          title: Mission
          description: Brand mission statement
        values:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Values
          description: Core brand values
        tagline:
          anyOf:
            - type: string
            - type: 'null'
          title: Tagline
          description: Brand tagline or slogan
        language:
          anyOf:
            - $ref: '#/components/schemas/BrandV2Language'
            - type: 'null'
          description: Brand language details
      type: object
      title: BrandV2Identity
      description: Structured brand identity block.
    BrandV2Language:
      properties:
        tone:
          anyOf:
            - type: string
            - type: 'null'
          title: Tone
          description: Brand tone of voice
        key_phrases:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Key Phrases
          description: Common brand phrases or messaging
      type: object
      title: BrandV2Language
      description: Structured brand language details.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````