API reference
Errors, limits and retries
Handle validation failures, rate limits and uncertain mutations without duplicates.
Error bodies contain an error string and can contain structured validation details.
Common responses
- 400: invalid JSON, invalid fields or a request that does not meet an action’s requirements. Fix the payload before retrying.
- 401: missing, invalid, expired or revoked bearer key. Check the key and selected workspace.
- 403: insufficient scope or the key issuer no longer has the necessary workspace permission. Dashboard session mutations can also reject a cross-origin request.
- 404: unsupported public resource or unknown resource/action identifier.
- 405: unsupported method, including generic writes to the call collection.
- 413: request body exceeds the supported limit.
- 422: an action’s configuration is inconsistent, such as a managed voice engine and model mismatch.
- 429: saved API-key request rate exceeded. Retry in the next minute.
- 503: storage or a required service is unavailable. Check status and contact support with the request time and sanitized error.
Provider operations can return additional action-specific failures. A successful HTTP exchange is not sufficient evidence of a successful booking when the returned provider receipt contains an application error.
Retry strategy
Read requests can be retried with bounded exponential backoff and jitter for temporary network/server failures. Honor the per-minute key limit.
For outbound calls, retain the original UUID idempotency key for the same intended call. For generic contact, agent, campaign or knowledge-base creation, the collection routes do not define an idempotency-key field. If the response is lost, inspect the stored collection before creating a duplicate.
Do not automatically repeat a booking cancellation, reschedule, CRM write or message whose external outcome is uncertain. Reconcile the provider record and action receipt first.
Information to include in support
Include the workspace identifier, request method/path, timestamp, HTTP status and sanitized error. Remove Authorization headers, tokens, passwords, patient details and full transcripts.