Skip to main content

🎉 Try Inworld voices, earn up to $100 in credits — Learn more →

Ultravox Docs home page

Overview

Ultravox REST API Overview

Accounts

GET
Get Account
GET
Get Call Usage
PATCH
Set TTS API keys
GET
Get Account TTS API Keys
PATCH
Set Telephony Credentials
GET
Get Telephony Credentials

Agents

GET
List Agents
POST
Create Agent
GET
Get Agent
PATCH
Update Agent
DEL
Delete Agent
GET
List Agent Calls
POST
Create Agent Call

Calls, Messages, Stages

Calls Overview
GET
List Calls
GET
Get Call
POST
Create Call
DEL
Delete Call
GET
List Call Messages
GET
List Call Tools
GET
Get Call Recording
GET
List Call Stages
GET
Get Call Stage
GET
List Call Stage Messages
GET
List Call Stage Tools
GET
Get Call Stage Message Audio
GET
List Deleted Calls
GET
Get Deleted Call
GET
List Call Events
GET
Get Sip Logs for a call
POST
Send Data Message to Call

Corpora, Query, Sources

Corpus Service (RAG) Overview
GET
List Corpora
POST
Create Corpus
GET
Get Corpus
PATCH
Update Corpus
DEL
Delete Corpus
POST
Query Corpus
GET
List Corpus Sources
POST
Create Corpus Source
GET
Get Corpus Source
PATCH
Update Corpus Source
DEL
Delete Corpus Source
GET
List Corpus Source Documents
GET
Get Corpus Source Document
POST
Create Corpus File Upload

Tools

GET
List Tools
GET
Get Tool
POST
Create Tool
PUT
Update Tool
DEL
Delete Tool
GET
Get Tool History
POST
Test Tool

Voices

GET
List Voices
GET
Get Voice
POST
Create (Clone) Voice
DEL
Delete Voice
PUT
Replace Voice
PATCH
Update Voice
POST
Preview Voice
GET
Get Voice Sample

Webhooks

GET
List Webhooks
GET
Get Webhook
POST
Create Webhook
PUT
Replace Webhook
PATCH
Update Webhook
DEL
Delete Webhook

SIP Configuration

GET
Get Account SIP configuration
PATCH
Update Account SIP configuration
POST
Create SIP Registration
GET
List SIP Registrations
GET
Get SIP Registration
PATCH
Update SIP Registration
DEL
Delete SIP Registration

Schema

Call Definition
Base Tool Definition
Ultravox Data Message Protocol

Other

GET
List Models
GET
Get OpenAPI Schema

Community
Dashboard

🎉 Try Inworld voices, earn up to $100 in credits — Learn more →

Ultravox Docs home page

Community
Dashboard
Dashboard

Schema

Ultravox Data Message Protocol

Protocol documentation for messages exchanged between client and server during Ultravox calls.

See Data Messages for more information.

List ModelsRetrieves the list of all available models that can be used for inference

⌘I

discord github x