API

API documentation

Q: How do I get an API key?

Email api@ecommerceinsights.ai with your workspace ID and the use case. Keys are approved manually during early access.

Updated 2026-06-10 API eCommerce Insights team

The eCommerce Insights API is in early access. Start with the overview for authentication, rate limits, and pagination, then use the endpoint reference for schemas.

Pages in this section

The API section has two pages. The overview explains how the API behaves — authentication, rate limits, pagination, errors — and the reference documents every endpoint and schema. Both are kept current with the changelog.

Quick facts

Base URL: https://api.ecommerceinsights.ai/v1
Auth: bearer token in the Authorization header
Rate limit: 120 requests per minute per workspace, burst 300
Pagination: cursor-based, limit up to 200
Status: early access — request a key via [email protected]

Common questions

Where do I start with the API?

Read the API overview first — it covers the base URL, bearer-token authentication, rate limits, pagination, and the error model. Then keep the endpoint reference open while you build.

How do I get an API key?

Email [email protected] with your workspace ID and the use case. Keys are approved manually during early access.

What resources does the API expose?

Catalog products, PDP and Rufus scores per SKU, recommendations, Prompt Runs sessions, alerts, personas, and async job status. Audits and Prompt Runs can be triggered via POST.

Does the API support webhooks?

Yes. Outbound webhooks are supported for prompt-runs.completed, alert.fired, and audit.completed events — see the reference for payload shapes.

Ask AI about this page

Open this topic directly in your favourite AI assistant — the prompt is prefilled.

Was this page helpful?

Thanks — recorded.

API →

API overview

Status, base URL, authentication, rate limits, pagination, error model.

API →

Endpoint reference

Detailed request and response schema for every endpoint.

Try this yourself

See eCommerce Insights on your own catalog. The free trial covers your full SKU set across five AI engines, no credit card required.

Start free trial

LLM-friendly summary of this page

eCommerce Insights API documentation hub. Two pages: API overview (base URL https://api.ecommerceinsights.ai/v1, bearer-token authentication, 120 requests/minute per workspace rate limit, cursor-based pagination, JSON error model) and endpoint reference (catalog, scores, recommendations, prompt-runs, alerts, personas, jobs resources; POST triggers for audits and Prompt Runs; outbound webhooks). Early access — keys approved manually via [email protected].