API reference
Every endpoint the control plane publishes: 305 operations across 221 paths, generated from the OpenAPI 3.1 document the routes themselves produce. Start with conventions — authentication, pagination, errors, idempotency and rate limits are the same everywhere and are not repeated per endpoint.
Spec version 2026-01-01. Download openapi.json.
Resources
| Resource | Group | Endpoints | Base path |
|---|---|---|---|
| Assistants | Core | 14 | /assistants |
| Structured outputs | Core | 7 | /structured-outputs |
| Tools | Core | 11 | /tools |
| Squads | Core | 9 | /squads |
| Knowledge bases | Core | 11 | /knowledge-bases |
| MCP servers | Core | 10 | /mcp-servers |
| Calls | Calls | 16 | /calls |
| Outbound calls | Calls | 1 | /telephony/calls |
| Transfers | Calls | 5 | /contact-center/calls/{callId}/transfer |
| Analytics | Calls | 3 | /analytics/overview |
| Boards | Calls | 9 | /boards |
| Monitors & evaluations | Calls | 16 | /eval-runs/{evalRunId} |
| Phone numbers | Telephony | 10 | /telephony/phone-numbers |
| Telephony accounts | Telephony | 7 | /telephony/accounts |
| Inbound & outbound routes | Telephony | 8 | /telephony/inbound-routes |
| SIP trunks | Telephony | 11 | /telephony/sip-trunks |
| SIP gateways | Telephony | 5 | /telephony/sip-trunks/{trunkId}/gateways |
| SIP DIDs | Telephony | 4 | /telephony/sip-trunks/{trunkId}/dids |
| Extensions | Telephony | 8 | /contact-center/extensions |
| Queues | Contact centre | 8 | /contact-center/queues |
| Operators | Contact centre | 14 | /contact-center/operators |
| Supervisor | Contact centre | 7 | /contact-center/supervisor/calls/{callId}/barge |
| Campaigns | Outbound | 16 | /campaigns |
| Suppression lists | Outbound | 8 | /suppression-lists |
| Customers | Outbound | 10 | /customers |
| Balance | Billing | 3 | /billing/balance |
| Credits | Billing | 3 | /billing/auto-reload |
| Invoices | Billing | 3 | /billing/invoices |
| Payment methods | Billing | 5 | /billing/payment-methods |
| Plans | Billing | 1 | /billing/plans |
| Usage | Billing | 2 | /billing/usage |
| API keys | Platform | 7 | /api-keys |
| Client tokens | Platform | 2 | /client-tokens |
| Webhook endpoints | Platform | 8 | /webhooks |
| Webhook deliveries | Platform | 3 | /webhook-deliveries |
| Provider credentials | Platform | 6 | /credentials |
| Integrations | Platform | 10 | /integrations |
| Provider registry | Platform | 6 | /registry |
| Catalogue | Platform | 18 | /contact-center/dispositions |
Everything else
- Schemas — every request and response object, field by field.
- Conventions — auth, errors, pagination, idempotency, versioning.
- Errors — every status and code a call can really return.
- Webhooks — the inbound half of the integration.