API by router
Voice channel
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
active_calls?Active CallsDefault
0enabled*Enabledphone_number?string|nullprovider?string|nullstatus*Statuswebhook_url*Webhook Urlcurl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/voice'Example Response
{ "active_calls": 0, "enabled": true, "phone_number": "string", "provider": "string", "status": "string", "webhook_url": "string"}POST
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
agent_id?|Retell agent/assistant ID
anthropic_api_key?|Anthropic API key for LLM
api_key?Api KeyProvider API key (Retell) — stored encrypted
Default
""cartesia_api_key?|Cartesia API key for TTS
deepgram_api_key?|Deepgram API key for STT
elevenlabs_api_key?|ElevenLabs API key for TTS
google_api_key?|Google API key for LLM/STT/TTS
openai_api_key?|OpenAI API key for LLM/TTS/STT
phone_number?|Phone number for inbound calls
provider?ProviderVoice provider slug (retell, pipecat)
Default
"retell"twilio_account_sid?|Twilio Account SID
twilio_auth_token?|Twilio Auth Token
twilio_phone_number?|Twilio phone number (E.164)
webhook_secret?|Provider webhook signing secret
Successful Response
application/json- response
active_calls?Active CallsDefault
0enabled*Enabledphone_number?string|nullprovider?string|nullstatus*Statuswebhook_url*Webhook Urlcurl -X POST 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/voice' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "active_calls": 0, "enabled": true, "phone_number": "string", "provider": "string", "status": "string", "webhook_url": "string"}DELETE
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/voice'Example Response
Empty
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?curl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/voice/calls'Example Response
[ { "call_id": "string", "caller_phone": "string", "duration_seconds": 0, "state": "string", "transcript_turns": 0 }]