Skip to main content
POST
Products List

Authorizations

X-API-Key
string
header
required

Body

application/json

Input model for brand product research endpoint.

brand_url
string
required

Required. Brand website URL to research for products. Provide this on every request, including pagination requests that also send a cursor.

Example:

"https://glossier.com"

brand_name
string | null
deprecated

Deprecated — brand name is now resolved automatically from the URL. This field is accepted but ignored.

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. When set, brand_url is still required and must match the brand encoded in the cursor. If omitted, the first page of results is returned.

limit
integer
default:10

Maximum number of products to return per page.

Required range: 5 <= x <= 20
include
enum<string>[] | null

Which per-product fields to return. Allowed values: 'description', 'image_url'. Omit the field to get 'description' only (the default). Add 'image_url' to also get product images. An explicit empty list returns name and url only. Unrequested fields are omitted from each result. Example: ["description", "image_url"]

Available options:
description,
image_url

Response

Successful Response

Response model for brand product research results.

brand_url
string
required

The brand's primary website URL

Example:

"https://www.glossier.com"

brand_name
string
required

The resolved brand name

Example:

"Glossier"

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 more pages of results are available.

Example:

true

effort
enum<string>
default:low

Depth actually traveled to produce this page (resolved; never 'auto'). 'low' = served from the catalog/listing with no per-product detail lookups; 'mid'/'high' = a growing share of results needed a detail lookup.

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

"low"