Back to Docs
API Reference
Complete reference for the VoiceAgent REST API.
Authentication
All API requests require authentication using a Bearer token in the Authorization header.
Authorization: Bearer YOUR_API_KEYRate Limits
100
requests/minute (Starter)
500
requests/minute (Pro)
Custom
requests/minute (Enterprise)
Quick Start
Create your first agent with a single API call.
curl -X POST https://api.protovoice.ai/v1/agents \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Support Agent",
"persona": "professional",
"voice": "nova",
"language": "en"
}'Endpoints
Agents
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/agents | List all agents |
| POST | /v1/agents | Create an agent |
| GET | /v1/agents/:id | Get agent details |
| PATCH | /v1/agents/:id | Update an agent |
| DELETE | /v1/agents/:id | Delete an agent |
Phone Numbers
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/phone-numbers | List phone numbers |
| POST | /v1/phone-numbers | Provision a number |
| POST | /v1/phone-numbers/:id/assign | Assign to agent |
| DELETE | /v1/phone-numbers/:id | Release a number |
Calls
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/calls | List call history |
| GET | /v1/calls/:id | Get call details |
| GET | /v1/calls/:id/transcript | Get transcript |
| GET | /v1/calls/:id/recording | Get recording URL |
Webhooks
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/webhooks | List webhooks |
| POST | /v1/webhooks | Create a webhook |
| DELETE | /v1/webhooks/:id | Delete a webhook |
