Skip to main content
POST
/
v1
/
brand
/
products
Products
curl --request POST \
  --url https://api.upriver.ai/v1/brand/products \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "auto": "Check out Nike's latest collection at nike.com",
  "brand_url": "https://nike.com",
  "brand_name": "Nike",
  "response_format": "json",
  "cursor": "<string>",
  "effort": "auto"
}
EOF
{
  "brand_url": "https://nike.com",
  "products": [
    {
      "name": "Air Max 270",
      "category": "Footwear",
      "description": "The Air Max 270 delivers visible cushioning under every step.",
      "url": "https://nike.com/air-max-270"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "effort": "low"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Input model for brand product research endpoint.

​
auto
string | null

Raw text containing brand information for auto-detection. When provided, brand name and URL will be extracted automatically.

Example:

"Check out Nike's latest collection at nike.com"

​
brand_url
string | null

The URL of the brand's website to research for products

Example:

"https://nike.com"

​
brand_name
string | null

The brand name to research (will search for website if URL not provided)

Example:

"Nike"

​
response_format
enum<string>
default:json

Format for the response: 'json' for structured data, 'text' for natural language

Available options:
json,
text
Example:

"json"

​
cursor
string | null

Use this to paginate through results, providing the next_cursor returned from a previous request. If omitted, the first page of results is returned.

​
effort
enum<string>
default:auto

Effort level for product research; 'auto' will adjust hydration effort based on result quality.

Available options:
auto,
low,
mid,
high

Response

Successful Response

Response model for brand product research results.

​
brand_url
string
required

The brand's primary website URL

Example:

"https://nike.com"

​
products
ProductInfo · object[]
required

List of products found on the brand's website

​
next_cursor
string | null

Pagination cursor for the next page of results (if available).

​
has_more
boolean | null

Whether there are more pages available.

Example:

true

​
effort
enum<string>
default:low

Effective effort level actually used to produce these results (resolved; never 'auto').

Available options:
auto,
low,
mid,
high
Example:

"low"