Base URL
Authentication
- Use bearer token/API key authentication based on your integration path.
- Include credentials in
Authorizationheader. - Ensure keys are stored securely and rotated regularly.
Endpoint families by domain
Auth, user, organisation, workspace
- Authentication verification
- User profile and invitation completion
- Organisation/workspace lifecycle endpoints
Agents, calls, numbers, contacts
- Agent lifecycle and configuration
- Call history and status operations
- Number provisioning/settings
- Contacts CRUD and bulk ingestion
Voice runtime
- Outbound call start
- Inbound call handling
- Runtime connection and status callbacks
Batch outbound campaigns
- Campaign management
- Uploads and batch contacts
- Batch jobs and progress monitoring
Knowledge, integrations, workflows
- Knowledge base lists/items
- Integration connect/sync/disconnect
- Workflow lifecycle and external triggers
Billing, analytics, developer tools
- Subscription/payment lifecycle
- Analytics endpoints
- API keys and secrets management
Webhooks and events
- Twilio (call/SMS events)
- Stripe billing events
- Clerk identity events
- Mobile messaging inbound events
Common use-case paths
Start a call
Trigger outbound calling from your application.
Build webhook consumers
Receive and verify post-call events and integration updates.
Run campaign automation
Launch campaigns with uploads, contacts, and jobs.
Secure admin integrations
Validate plan/role gating before provisioning credentials.
Notes
- Some features/endpoints are plan or role gated.
- Confirm workspace context for all tenant-scoped calls.
- Use idempotent handling for webhook/event processing paths.