API ReferenceVoice Agent Beta

Create a new call

Create a new voice agent call session.

Authentication

x-api-keystring
Your API Activation Key

Request

This endpoint expects an object.
userobjectRequired
The user that this voice agent call is being initiated for
languageenumRequired
The code of the language being spoken by the user in the call
agentobjectRequired
Configuration for the AI voice agent to be used in the call
phoneNumberstringOptional
The phone number to call for the voice agent interaction
webhookUrlstringOptionalformat: "uri"1-2083 characters
Optional webhook URL to receive call status updates and results
metadataobjectOptional
Additional metadata associated with the voice agent call
deleteDatabooleanOptionalDefaults to false
Boolean flag indicating if call data should be deleted after completion. If True, the call recordings, transcripts, and results will be deleted 12 hrs after the call ends. Attempts to retrieve results after this time will receive a 404 error.

Response

Successful Response
idstringformat: "uuid"
The id of the newly created call
userobject
statusstring
Current status of the call
createdAtdatetime
When the call was submitted to the API
agentobject
Configuration for the AI voice agent to be used in the call

Errors