Media Categories Search - Upriver API Docs

POST

categories

Media Categories Search

curl --request POST \
  --url https://api.upriver.ai/v1/categories/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "text": "<string>",
  "top_k": 5
}
'

{
  "matches": [
    {
      "category_id": "<string>",
      "display_name": "<string>",
      "level": 123,
      "confidence": 0.5,
      "parent_id": "<string>",
      "reason": "<string>"
    }
  ],
  "query_text": "<string>"
}

Authorizations

X-API-Key

string

header

required

Body

application/json

Search parameters

text

string

required

Freeform text to match against category taxonomy

Example:

"telehealth and men's health"

top_k

integer

default:5

Number of categories to return, ordered by relevance

Required range: 1 <= x <= 20

Response

Successful Response

Response from category search endpoint.

matches

CategoryMatch · object[]

required

Ordered list of matched categories (highest confidence first)

Show child attributes

query_text

string

required

The input text that was matched

Media CategoriesReturns 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.

⌘I

Media Categories Search

curl --request POST \
  --url https://api.upriver.ai/v1/categories/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "text": "<string>",
  "top_k": 5
}
'

{
  "matches": [
    {
      "category_id": "<string>",
      "display_name": "<string>",
      "level": 123,
      "confidence": 0.5,
      "parent_id": "<string>",
      "reason": "<string>"
    }
  ],
  "query_text": "<string>"
}