API overview - PlatformDTC

https://api.platformdtc.com/api/v1/agent/v1

The Endpoints section in the sidebar is generated from the OpenAPI spec and includes an interactive playground — set your X-Agent-Key and call live.

Conventions

Auth: X-Agent-Key: sq_agt_* (or Authorization: Bearer). See Authentication.
Idempotency: every non-GET requires Idempotency-Key. See Idempotency.
Envelope (success): { "success": true, "message": "…", "data": … }. Async ops return data: { job_id, status, poll }.
Envelope (error): { "success": false, "message": "…", "error_code": "…", "errors": … }. See Errors.
Pagination: list endpoints return data: { items, total, page, limit }.

Surface map

Group	Endpoints
Meta	`GET /whoami`, `GET /capabilities`, `GET /health`
Jobs	`GET /jobs`, `GET /jobs/{id}`, `GET /jobs/{id}/wait`, `POST /jobs/{id}/cancel`
Store	`POST /projects`, `GET /projects/{id}/status`, `POST /landing-pages`, `POST /projects/{id}/publish`, `POST /projects/{id}/domains`
Catalog	`POST /products`, `GET /products`, `POST /products/bulk`, `POST /collections`, `GET /catalog/search`
Ads	`POST /ads/{platform}/connect`, `GET /ads/accounts`, `POST /ads/{platform}/sync`, `GET /ads/insights`
Marketing	`POST /campaigns`, `POST /campaigns/{id}/send`, `POST /segments`
Analytics	`GET /analytics/dashboard`
Orders	`GET /orders`, `POST /orders/{id}/fulfill`
Approvals	`POST /approvals/{job_id}/resolve`
Admin	`POST/GET /keys`, `POST /keys/{id}/rotate`, `DELETE /keys/{id}`, `POST/GET /webhooks`, `DELETE /webhooks/{id}`, `GET /audit`

A few routes named in the design (e.g. /automations, /analytics/daily-summary, /campaigns/{id}/analytics, /jobs/{id}/stream, /orders/import) are planned and not yet live. The Endpoints reference below lists only what’s shipped.