Developer API

Use the IntentFlow API to power autocomplete experiences, custom storefront UIs, and platform integrations.

Base URL

https://app.example.com

PLACEHOLDER: Replace this with the production API host and any regional hosts.

Versioning

Current public API namespace:

/api/v1

Breaking changes should be introduced under a new version path.

Available endpoints

Method	Endpoint	Purpose	Status
GET	/api/v1/autocomplete	Return suggestions and product matches for a store.	Available
POST	/api/v1/product-imports	Upload a store product CSV for background processing.	Available
GET	/api/v1/product-imports/{import_id}	Check product import progress and counts.	Available
POST	/api/v1/events	Queue batched search journey events for attribution and aggregate analytics.	Available
GET	/widget.js	Serve the embeddable storefront widget.	Available
POST	/api/v1/products	Create or update products directly without CSV.	PLACEHOLDER
DELETE	/api/v1/products/{external_id}	Remove or deactivate a product.	PLACEHOLDER
GET	/api/v1/health	Integration health check.	PLACEHOLDER

Request format

• Send JSON for request bodies unless an endpoint states otherwise.
• Send store API keys with X-Api-Key.
• Use UTF-8 for all text values.
• Use HTTPS in production.

Response format

Successful responses return JSON. Endpoint pages document their exact envelope.

Errors return JSON with a stable status code and message. See Errors & Limits.

Example

curl 'https://app.example.com/api/v1/autocomplete?q=run&limit=5' \
  -H 'X-Api-Key: if_PLACEHOLDER_KEY'

SDKs

PLACEHOLDER: Add official SDKs, package names, minimum versions, and installation examples.