Base URL
Authentication
All/api/v1/* endpoints require an API key passed in the x-api-key header.
default_project.api_key) and shown exactly once. If you need to create additional keys or rotate an existing one, use the API Keys endpoints.
Auth endpoints (/auth/*) are public — no key required.
API Key Format
Keys always start withecho_ followed by 64 hex characters:
Endpoint Groups
Auth
Sign up, log in, and refresh tokens.
Customers
Register and manage the people you want to call.
Agents
Create and manage reusable voice personas.
Notifications
Trigger outbound calls and inspect results.
API Keys
Create and revoke project API keys.
Project
Inspect project settings.
Webhook Endpoints
Register and manage webhook endpoints with per-endpoint signing secrets.
Delivery Logs
Inspect delivery history, per-attempt details, and manually retry failures.
Error Codes
| Status | Meaning |
|---|---|
400 Bad Request | Validation error on the request body |
401 Unauthorized | Missing or invalid API key |
403 Forbidden | Valid key but insufficient access |
404 Not Found | Customer, agent, or notification not found in your project/business |
409 Conflict | external_id already exists for this project |