upriver-ai Taxonomy API

openapi: 3.2.0
info:
  title: Upriver Taxonomy 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
tags:
- name: Taxonomy
paths:
  /v1/categories/search:
    post:
      tags:
      - Taxonomy
      summary: Media Categories Search
      description: Find the most relevant categories from the taxonomy for a given freeform text. Useful for discovering the best category for brand industries, target audiences, etc. Returns ordered matches with confidence scores.
      operationId: search_categories
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CategorySearchInput'
              description: Search parameters
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategorySearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-agent-description: 'Find the most relevant categories from the taxonomy for a given freeform text (e.g., { "text": "gaming and esports" }). Useful for discovering valid category values to pass as filters to the sponsors, sponsorships, and breakout topics endpoints. Returns ordered category matches with confidence scores.'
      x-agent-params:
      - text
  /v1/media_categories:
    get:
      tags:
      - Taxonomy
      summary: Media Categories
      description: Returns the media categories split into L1 (top-level) and L2 (second-level) lists. These categories can be used as a filter for sponsors, sponsorships. and other endpoints which support filtering by categories.
      operationId: media_categories
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoriesResponse'
      security:
      - APIKeyHeader: []
      x-agent-description: Returns the media categories split into L1 (top-level) and L2 (second-level) lists. These categories can be used as a filter for sponsors, sponsorships, and other endpoints.
components:
  schemas:
    CategorySearchInput:
      properties:
        text:
          type: string
          title: Text
          description: Freeform text to match against category taxonomy
          examples:
          - telehealth and men's health
        top_k:
          type: integer
          maximum: 20.0
          minimum: 1.0
          title: Top K
          description: Number of categories to return, ordered by relevance
          default: 5
      type: object
      required:
      - text
      title: CategorySearchInput
      description: Input for category search endpoint.
    TaxonomyCategory:
      properties:
        category_id:
          type: string
          title: Category Id
          description: Stable category slug id
        display_name:
          type: string
          title: Display Name
          description: Human-readable name
        level:
          type: integer
          title: Level
          description: 'Hierarchy level: 1 for L1, 2 for L2'
        parent_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent Id
          description: Parent category id (for L2 items)
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Optional description
        aliases:
          items:
            type: string
          type: array
          title: Aliases
          description: Known aliases
      type: object
      required:
      - category_id
      - display_name
      - level
      title: TaxonomyCategory
      description: A single taxonomy category item (L1 or L2).
    CategorySearchResponse:
      properties:
        matches:
          items:
            $ref: '#/components/schemas/CategoryMatch'
          type: array
          title: Matches
          description: Ordered list of matched categories (highest confidence first)
        query_text:
          type: string
          title: Query Text
          description: The input text that was matched
      type: object
      required:
      - matches
      - query_text
      title: CategorySearchResponse
      description: Response from category search endpoint.
    CategoryMatch:
      properties:
        category_id:
          type: string
          title: Category Id
          description: Category ID from taxonomy
        display_name:
          type: string
          title: Display Name
          description: Human-readable category name. Use this for embedding-based resolution in downstream endpoints.
        level:
          type: integer
          title: Level
          description: Taxonomy level (1 or 2)
        parent_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent Id
          description: Parent category ID for L2 categories
        confidence:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Confidence
          description: Confidence score for this match
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: Explanation for why this category was chosen
      type: object
      required:
      - category_id
      - display_name
      - level
      - confidence
      title: CategoryMatch
      description: 'A matched category with confidence score.


        Note: When passing the matched category to other endpoints that use

        embedding-based resolution (like /sponsors), use the display_name field

        rather than category_id for better embedding matches.'
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CategoriesResponse:
      properties:
        l1:
          items:
            $ref: '#/components/schemas/TaxonomyCategory'
          type: array
          title: L1
          description: Top-level categories (level=1)
        l2:
          items:
            $ref: '#/components/schemas/TaxonomyCategory'
          type: array
          title: L2
          description: Second-level categories (level=2)
      type: object
      required:
      - l1
      - l2
      title: CategoriesResponse
      description: Response containing lists of L1 and L2 taxonomy categories.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key