Skip to main content
GET
/
api
/
calls
/
{call_id}
/
stages
/
{call_stage_id}
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/calls/{call_id}/stages/{call_stage_id} \
  --header 'X-API-Key: <api-key>'
{
  "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "callStageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "initialTokenCount": 123,
  "latestTokenCount": 123,
  "temperature": 123,
  "errorCount": 123,
  "experimentalSettings": "<unknown>",
  "initialState": {},
  "inactivityMessages": [
    {
      "duration": "<string>",
      "message": "<string>",
      "endBehavior": "END_BEHAVIOR_UNSPECIFIED"
    }
  ],
  "languageHint": "<string>",
  "model": "<string>",
  "systemPrompt": "<string>",
  "timeExceededMessage": "<string>",
  "voice": "<string>",
  "externalVoice": {
    "elevenLabs": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "useSpeakerBoost": true,
      "style": 123,
      "similarityBoost": 123,
      "stability": 123,
      "pronunciationDictionaries": [
        {
          "dictionaryId": "<string>",
          "versionId": "<string>"
        }
      ],
      "optimizeStreamingLatency": 123,
      "maxSampleRate": 123
    },
    "cartesia": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "emotion": "<string>",
      "emotions": [
        "<string>"
      ],
      "generationConfig": {
        "volume": 123,
        "speed": 123,
        "emotion": "<string>",
        "pronunciationDictId": "<string>"
      }
    },
    "lmnt": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "conversational": true
    },
    "google": {
      "voiceId": "<string>",
      "speakingRate": 123
    },
    "inworld": {
      "voiceId": "<string>",
      "modelId": "<string>",
      "speakingRate": 123,
      "temperature": 123,
      "applyTextNormalization": true
    },
    "respeecher": {
      "voiceId": "<string>",
      "model": "<string>",
      "seed": 123,
      "temperature": 123,
      "topK": 123,
      "topP": 123,
      "minP": 123,
      "presencePenalty": 123,
      "repetitionPenalty": 123,
      "frequencyPenalty": 123
    },
    "generic": {
      "url": "<string>",
      "headers": {},
      "body": {},
      "responseSampleRate": 123,
      "responseWordsPerMinute": 123,
      "responseMimeType": "<string>",
      "jsonAudioFieldPath": "<string>",
      "jsonByteEncoding": "JSON_BYTE_ENCODING_UNSPECIFIED"
    }
  },
  "voiceOverrides": {
    "elevenLabs": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "useSpeakerBoost": true,
      "style": 123,
      "similarityBoost": 123,
      "stability": 123,
      "pronunciationDictionaries": [
        {
          "dictionaryId": "<string>",
          "versionId": "<string>"
        }
      ],
      "optimizeStreamingLatency": 123,
      "maxSampleRate": 123
    },
    "cartesia": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "emotion": "<string>",
      "emotions": [
        "<string>"
      ],
      "generationConfig": {
        "volume": 123,
        "speed": 123,
        "emotion": "<string>",
        "pronunciationDictId": "<string>"
      }
    },
    "lmnt": {
      "voiceId": "<string>",
      "model": "<string>",
      "speed": 123,
      "conversational": true
    },
    "google": {
      "voiceId": "<string>",
      "speakingRate": 123
    },
    "inworld": {
      "voiceId": "<string>",
      "modelId": "<string>",
      "speakingRate": 123,
      "temperature": 123,
      "applyTextNormalization": true
    },
    "respeecher": {
      "voiceId": "<string>",
      "model": "<string>",
      "seed": 123,
      "temperature": 123,
      "topK": 123,
      "topP": 123,
      "minP": 123,
      "presencePenalty": 123,
      "repetitionPenalty": 123,
      "frequencyPenalty": 123
    },
    "generic": {
      "url": "<string>",
      "headers": {},
      "body": {},
      "responseSampleRate": 123,
      "responseWordsPerMinute": 123,
      "responseMimeType": "<string>",
      "jsonAudioFieldPath": "<string>",
      "jsonByteEncoding": "JSON_BYTE_ENCODING_UNSPECIFIED"
    }
  }
}

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
​
callStageId
string<uuid>
required
​
created
string<date-time>
required
​
initialTokenCount
integer | null
required

The initial length of the prompt in tokens.

​
latestTokenCount
integer | null
required

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

​
temperature
number<double>
required
​
errorCount
integer
required

The number of errors in this call stage.

​
experimentalSettings
any | null
required

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.