API
API authentication
Create scoped API keys and authenticate server-side requests with zero ambiguity.
Interactive Explorer
💡
Try our live interactive API Explorer at /docs/api to test endpoints, generate multi-language code snippets, and verify webhook signatures directly in your browser.
Generate an API key
1
Access Developers settings
Navigate to Dashboard → Developers → API Keys. Only organization Owners and Admins can create or revoke API keys.
2
Select least-privilege scopes
Choose 'read' for logs/analytics, 'calls:trigger' for outbound calling, 'agents:write' for programmatic prompt updates, or 'full-access' for unconstrained automation.
3
Save and protect
Store the generated key prefixed with 'avp_' in an encrypted secrets manager (e.g. AWS Secrets Manager, Doppler, or HashiCorp Vault). The key is shown only once.
Authentication headers
Vozon supports two authentication headers. You can pass the standard HTTP Bearer header or the x-api-key header:
http
Authorization: Bearer avp_live_your_api_key_here
# or
x-api-key: avp_live_your_api_key_here| Scope | Permitted actions | Recommended for |
|---|---|---|
| read | GET /agents, GET /calls, GET /calls/{id}, GET /calls/stream | Dashboards, CRM sync, and reporting |
| calls:trigger | POST /calls/outbound, POST /outbound-calls | Backend servers triggering automated voice calls |
| agents:write | Create, update, and publish voice agent configurations | CI/CD and agent prompt synchronization |
| full-access | All external API actions | Internal administrative tooling |
⚠️
Never embed API keys in client-side code (Next.js client components, mobile apps, or frontend scripts). Always make requests from your secure backend server.