Skip to main content
POST
/
v1
/
brand
/
products
Products List
curl --request POST \
  --url https://api.upriver.ai/v1/brand/products \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "brand_url": "https://glossier.com",
  "brand_name": "<string>",
  "response_format": "json",
  "cursor": "<string>",
  "limit": 10,
  "include": []
}
'
import requests

url = "https://api.upriver.ai/v1/brand/products"

payload = {
    "brand_url": "https://glossier.com",
    "brand_name": "<string>",
    "response_format": "json",
    "cursor": "<string>",
    "limit": 10,
    "include": []
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brand_url: 'https://glossier.com',
    brand_name: '<string>',
    response_format: 'json',
    cursor: '<string>',
    limit: 10,
    include: []
  })
};

fetch('https://api.upriver.ai/v1/brand/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upriver.ai/v1/brand/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'brand_url' => 'https://glossier.com',
    'brand_name' => '<string>',
    'response_format' => 'json',
    'cursor' => '<string>',
    'limit' => 10,
    'include' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upriver.ai/v1/brand/products"

	payload := strings.NewReader("{\n  \"brand_url\": \"https://glossier.com\",\n  \"brand_name\": \"<string>\",\n  \"response_format\": \"json\",\n  \"cursor\": \"<string>\",\n  \"limit\": 10,\n  \"include\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.upriver.ai/v1/brand/products")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand_url\": \"https://glossier.com\",\n  \"brand_name\": \"<string>\",\n  \"response_format\": \"json\",\n  \"cursor\": \"<string>\",\n  \"limit\": 10,\n  \"include\": []\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.upriver.ai/v1/brand/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"brand_url\": \"https://glossier.com\",\n  \"brand_name\": \"<string>\",\n  \"response_format\": \"json\",\n  \"cursor\": \"<string>\",\n  \"limit\": 10,\n  \"include\": []\n}"

response = http.request(request)
puts response.read_body
{
  "brand_url": "https://www.glossier.com",
  "brand_name": "Glossier",
  "products": [
    {
      "name": "<string>",
      "category": "Brows",
      "description": "A brushable, buildable brow gel that shapes and fills brows.",
      "url": "https://www.glossier.com/products/boy-brow",
      "image_url": "https://www.glossier.com/cdn/images/boy-brow.jpg"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "effort": "low"
}
{
  "detail": "No products found on https://example.com"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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"