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_KEY

Rate 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

MethodEndpointDescription
GET/v1/agentsList all agents
POST/v1/agentsCreate an agent
GET/v1/agents/:idGet agent details
PATCH/v1/agents/:idUpdate an agent
DELETE/v1/agents/:idDelete an agent

Phone Numbers

MethodEndpointDescription
GET/v1/phone-numbersList phone numbers
POST/v1/phone-numbersProvision a number
POST/v1/phone-numbers/:id/assignAssign to agent
DELETE/v1/phone-numbers/:idRelease a number

Calls

MethodEndpointDescription
GET/v1/callsList call history
GET/v1/calls/:idGet call details
GET/v1/calls/:id/transcriptGet transcript
GET/v1/calls/:id/recordingGet recording URL

Webhooks

MethodEndpointDescription
GET/v1/webhooksList webhooks
POST/v1/webhooksCreate a webhook
DELETE/v1/webhooks/:idDelete a webhook