Skip to main content
The Platform API is the HTTP API at https://api.depict.ai. Use it when you want full control over the UX instead of the pre-built Depict UI SDK. It covers four areas, which you can integrate independently:
  1. Search — search results and query suggestions
  2. Listings — category and collection pages: listing metadata, the navigation tree, and products
  3. Recommendations — product recommendations
  4. Tracking — the interaction events that power attribution, metrics and ranking
The generated endpoint reference is in the API Reference tab, under Platform API. Whichever areas you integrate, also complete the tracking guide — without tracking events, attribution and ranking do not work.

​
Build with an AI agent

Use Build an integration with an AI agent for search, listings, recommendations and tracking. Use Build collection pages with an AI agent for category and collection pages. Both pages include a short prompt and reference instructions. Supply your merchant configuration when the agent asks.

​
Versions

The Platform API currently has two active versions. Build new integrations against the /v3 endpoints — /v3 is the successor to /v2. /v2 is expected to be deprecated within roughly 6 months and /v3 within roughly 9 months, with a v4 API expected in Q4. These are expectations, not committed dates — confirm timelines with your Depict contact before planning a migration deadline.
The /v2/recommend/products/category endpoint follows a different schedule from the rest of /v2: see category recommendations.

​
Request conventions on v3

v3 request bodies silently ignore unknown fields. A misspelled field name (for example Limit instead of limit) is dropped without an error, so the request succeeds with the field’s default instead of failing.

​
Markets, locales and currency

Enumerate the valid market and locale values for your account at runtime:
These endpoints return separate lists. They do not return valid market and locale pairs. Use the pairs configured for your storefront.
There is no currency request parameter anywhere in the API. Prices arrive pre-resolved inside display objects for the requested market and locale, and the only currency code the serving API emits is on range-filter metadata (for price sliders). On tracking events you supply currency yourself.
If you are using TypeScript you can see all API type definitions here