Base URL
Authentication
Most API endpoints require authentication using a Bearer token. Pass your API key in theAuthorization header:
Some endpoints are public (no authentication required) — these are used by the embeddable chat widget. They are marked as “Public” in the documentation.
Request format
- Send JSON in the request body with
Content-Type: application/json - File uploads use
multipart/form-data - Query parameters are passed in the URL
Response format
All responses return JSON with asuccess field:
HTTP status codes
Rate limiting
API requests are rate limited. When rate limited, the response includes these headers:
If you receive a
429 response, wait until the reset time before retrying.
Credits
API chat requests consume credits just like widget conversations. The response includes acredits object showing how many credits were used and your remaining balance.