API reference for developers
Connect your own app to your workspace: the REST API, its keys and scopes, errors, rate limits and webhooks.
Where to find it
⚙️ Settings › API reference · Home page › Resources › API reference
Open this screen
Steps
- Open “API reference” in the sidebar, or “API reference” in the home page’s “Resources” menu.
- Start with “Start here”: “Base URL & conventions”, “Authentication” and “Scopes”.
- Look up “Endpoints” by group; each shows its parameters, request body, response and errors with examples.
- Read “Errors & status codes”, “Rate limits” and “Webhooks (outbound)” before going live. “OpenAPI JSON” downloads the whole specification.
Troubleshooting
How do I get an API key?
Keys are issued for your workspace on request; they cannot be created in the app yet. Your workspace’s keys are listed on the developer page of the AI area, where the people who manage the workspace can also add and test webhook endpoints.
Tips
- Call the API from your server only. Never put a key in a web page or a mobile app.
Good to know
- The API reference is readable without signing in.
Related how-tos
- How do I find an endpoint and copy an example? Search the API reference, jump to an endpoint, and copy its example or link.
- How do I read the common questions (Docs)? Read short answers about what the product does today: getting started, languages and voices, test calls, phone numbers, plans and account.
- Capabilities The full catalogue of call-centre capabilities, each marked honestly as shipped or planned.