GET
/
api
/
calls
/
{call_id}
/
stages
curl --request GET \
  --url https://api.ultravox.ai/api/calls/{call_id}/stages \
  --header 'X-API-Key: <api-key>'
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "callStageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "inactivityMessages": [
        {
          "duration": "<string>",
          "message": "<string>",
          "endBehavior": "END_BEHAVIOR_UNSPECIFIED"
        }
      ],
      "languageHint": "<string>",
      "model": "fixie-ai/ultravox",
      "systemPrompt": "<string>",
      "temperature": 123,
      "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>"
            }
          ]
        },
        "cartesia": {
          "voiceId": "<string>",
          "model": "<string>",
          "speed": 123,
          "emotion": "<string>"
        },
        "playHt": {
          "userId": "<string>",
          "voiceId": "<string>",
          "model": "<string>",
          "speed": 123,
          "quality": "<string>",
          "temperature": 123,
          "emotion": 123,
          "voiceGuidance": 123,
          "styleGuidance": 123,
          "textGuidance": 123,
          "voiceConditioningSeconds": 123
        },
        "lmnt": {
          "voiceId": "<string>",
          "model": "<string>",
          "speed": 123,
          "conversational": true
        }
      },
      "errorCount": 123,
      "experimentalSettings": "<any>",
      "initialState": {}
    }
  ],
  "total": 123
}

Stages represent distinct segments of the conversation where different parameters (e.g. system prompt or tools) may have been used.

Authorizations

X-API-Key
string
header
required

API key

Path Parameters

call_id
string
required

Query Parameters

cursor
string

The pagination cursor value.

pageSize
integer

Number of results to return per page.

Response

200 - application/json
results
object[]
required
next
string | null
Example:

"http://api.example.org/accounts/?cursor=cD00ODY%3D\""

previous
string | null
Example:

"http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"

total
integer
Example:

123