Developer overview
The ConnectWiz HTTP API is described by a single OpenAPI 3.1 document, which is the single source of truth for the contract. The interactive API reference on this site is generated from it, so when the API changes, the reference changes with it.
Start here
| Topic | Page |
|---|---|
| Your own storefront, app or checkout on ConnectWiz | Commerce API |
| Running a workspace's AI tools from your backend | Tools API |
| The chat widget on your website | Chat widget |
| Rich message content: buttons, cards, sliders | Message blocks |
| The error envelope and status codes | Errors |
| Throttling, headers, and the noisy-neighbor limiter | Rate limiting |
| Per-request locale negotiation | Localization |
| Every endpoint, interactively | API reference |
Conventions
- Base path: API endpoints are served under
/api(for example/api/login,/api/conversations). The Sanctum CSRF endpoint is/sanctum/csrf-cookie. - IDs are UUIDs (UUIDv7).
- Single resources are wrapped in
{ "data": { ... } }. - Collections are paginated:
{ "data": [ ... ], "meta": { ... } }wheremetacarriescurrent_page,per_page,total,last_page. - Pagination input:
?page=(1-based) and?per_page=(max 100). - Timestamps are ISO 8601 / RFC 3339.