API Documentation
Endpoints
Complete reference of all available endpoints
All API endpoints are protected with API key authentication. You must include a valid API key in the Authorization header with each request. Email us and we’ll help you get set up.
Authentication
To authenticate with the API, include your API key in the Authorization
header of your requests.
Example
If you’re using a client library:
Obtaining an API Key
Email us to obtain an API key and we’ll help you get set up. API keys should be kept secure and not shared.
Product Search
Search for products using text queries and LLM reranking.
Query Parameters
Parameter | Type | Description |
---|---|---|
q | string | Search query text (required) |
brand_url | string | Base brand URL to filter by, e.g., nike.com (optional) |
limit | number | Maximum number of results (default: 20) |
include_raw_data | boolean | Include raw html/json data from pdp (default: false) |
Get a Product by ID
Retrieve a product by its ID.
Path Parameters
Parameter | Type | Description |
---|---|---|
id | string | Product ID |
Query Parameters
Parameter | Type | Description |
---|---|---|
include_raw_data | boolean | Include raw html/json data from pdp (default: false) |
Filter Products by URL
Retrieve a product by its URL.
Query Parameters
Parameter | Type | Description |
---|---|---|
url | string | The product URL to fetch |
include_raw_data | boolean | Include raw html/json data from pdp (default: false) |
Health Check
Check API health status.