Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

API key

Path Parameters

call_id
string<uuid>
required
call_stage_id
string<uuid>
required

Response

200 - application/json
callId
string<uuid>
required
read-only
callStageId
string<uuid>
required
read-only
created
string<date-time>
required
read-only
initialTokenCount
integer | null
required
read-only

The initial length of the prompt in tokens.

latestTokenCount
integer | null
required
read-only

The latest length of the prompt in tokens. Updated as the call stage progresses.

temperature
number<double>
required
read-only
errorCount
integer
required
read-only

The number of errors in this call stage.

experimentalSettings
any | null
required
read-only

Experimental settings for this call stage.

initialState
object
required

The initial state of the call stage which is readable/writable by tools.

inactivityMessages
object[]

Messages spoken by the agent when the user is inactive for the specified duration. Durations are cumulative, so a message m > 1 with duration 30s will be spoken 30 seconds after message m-1.

languageHint
string | null

BCP47 language code that may be used to guide speech recognition.

Maximum string length: 16
model
string
systemPrompt
string | null
timeExceededMessage
string | null
voice
string | null
externalVoice
object

A voice not known to Ultravox Realtime that can nonetheless be used for a call. Such voices are significantly less validated than normal voices and you'll be responsible for your own TTS-related errors. Exactly one field must be set.

voiceOverrides
object

Overrides for the selected voice.