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

# Get Discovery Feed



## OpenAPI

````yaml /api-reference/openapi.json get /v1/discovery/feeds/{feed_slug}
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: Trends Radar (Beta)
  - name: Breakout Topics
  - name: Taxonomy
paths:
  /v1/discovery/feeds/{feed_slug}:
    get:
      tags:
        - Discovery Feeds
      summary: Get Discovery Feed
      operationId: get_discovery_feed
      parameters:
        - name: feed_slug
          in: path
          required: true
          schema:
            type: string
            title: Feed Slug
        - name: release_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^[0-9a-f]{64}$
              - type: 'null'
            title: Release Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveryFeedResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    DiscoveryFeedResponse:
      properties:
        feed:
          $ref: '#/components/schemas/FeedSummary'
        release_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Release Id
          description: Saved edition identifier. Null before the first successful refresh.
        published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Published At
          description: When this edition was published, separate from source publication.
        freshness:
          anyOf:
            - $ref: '#/components/schemas/FeedFreshness'
            - type: 'null'
        examined_window_start:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Examined Window Start
        examined_window_end:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Examined Window End
        time_basis:
          anyOf:
            - type: string
              enum:
                - published
                - observed
                - publication_proxy
                - mixed
            - type: 'null'
          title: Time Basis
        status:
          type: string
          enum:
            - pending
            - ready
            - empty
          title: Status
        refresh_status:
          type: string
          enum:
            - pending
            - running
            - succeeded
            - failed
          title: Refresh Status
        last_attempt_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Attempt At
        is_current:
          type: boolean
          title: Is Current
          description: Whether this is the feed's current edition.
        items:
          items:
            $ref: '#/components/schemas/FeedItem'
          type: array
          title: Items
          description: Selected discoveries with exact examples and qualified meanings.
        provenance:
          anyOf:
            - $ref: '#/components/schemas/FeedProvenance'
            - type: 'null'
      type: object
      required:
        - feed
        - release_id
        - published_at
        - freshness
        - examined_window_start
        - examined_window_end
        - time_basis
        - status
        - refresh_status
        - last_attempt_at
        - is_current
        - items
      title: DiscoveryFeedResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FeedSummary:
      properties:
        slug:
          type: string
          minLength: 1
          title: Slug
        label:
          type: string
          minLength: 1
          title: Label
        version:
          type: string
          minLength: 1
          title: Version
        facets:
          items:
            $ref: '#/components/schemas/PublicFeedFacet'
          type: array
          title: Facets
      additionalProperties: false
      type: object
      required:
        - slug
        - label
        - version
        - facets
      title: FeedSummary
    FeedFreshness:
      properties:
        status:
          type: string
          enum:
            - ready
            - partial
            - stale
            - unknown
          title: Status
        evaluated_at:
          type: string
          format: date-time
          title: Evaluated At
        collection_checked_through:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Collection Checked Through
        discovery_processed_through:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Discovery Processed Through
        max_lag_seconds:
          type: integer
          title: Max Lag Seconds
        notes:
          items:
            type: string
          type: array
          title: Notes
          default:
            - Coverage describes the examined sources, not the whole platform.
            - Cited examples are not discussion volume or measured growth.
      additionalProperties: false
      type: object
      required:
        - status
        - evaluated_at
        - collection_checked_through
        - discovery_processed_through
        - max_lag_seconds
      title: FeedFreshness
    FeedItem:
      properties:
        item_id:
          type: string
          pattern: ^[0-9a-f]{64}$
          title: Item Id
        kind:
          type: string
          enum:
            - topic
            - format
            - observation
          title: Kind
        facets:
          items:
            type: string
          type: array
          title: Facets
        history_scope:
          type: string
          const: selected_occurrences_in_view
          title: History Scope
          default: selected_occurrences_in_view
        latest:
          $ref: '#/components/schemas/FeedOccurrence'
        other_occurrences_in_latest_window:
          items:
            $ref: '#/components/schemas/FeedOccurrence'
          type: array
          title: Other Occurrences In Latest Window
          default: []
        previous_occurrences:
          items:
            $ref: '#/components/schemas/FeedOccurrence'
          type: array
          title: Previous Occurrences
          default: []
        related_items:
          items:
            $ref: '#/components/schemas/FeedRelatedItem'
          type: array
          maxItems: 100
          title: Related Items
          default: []
      additionalProperties: false
      type: object
      required:
        - item_id
        - kind
        - facets
        - latest
      title: FeedItem
    FeedProvenance:
      additionalProperties: true
      type: object
    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
    PublicFeedFacet:
      properties:
        slug:
          type: string
          minLength: 1
          title: Slug
        label:
          type: string
          minLength: 1
          title: Label
      additionalProperties: false
      type: object
      required:
        - slug
        - label
      title: PublicFeedFacet
    FeedOccurrence:
      additionalProperties: true
      type: object
    FeedRelatedItem:
      properties:
        item_id:
          type: string
          pattern: ^[0-9a-f]{64}$
          title: Item Id
        relation:
          type: string
          enum:
            - narrower
            - broader
            - related
          title: Relation
        reason:
          type: string
          minLength: 1
          title: Reason
        source_occurrence_id:
          type: string
          pattern: ^[0-9a-f]{64}$
          title: Source Occurrence Id
        target_occurrence_id:
          type: string
          pattern: ^[0-9a-f]{64}$
          title: Target Occurrence Id
      additionalProperties: false
      type: object
      required:
        - item_id
        - relation
        - reason
        - source_occurrence_id
        - target_occurrence_id
      title: FeedRelatedItem
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.