GET
/
api
/
tools
/
{tool_id}
/
history
curl --request GET \
  --url https://api.ultravox.ai/api/tools/{tool_id}/history \
  --header 'X-API-Key: <api-key>'
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "call": {
        "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clientVersion": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "joined": "2023-11-07T05:31:56Z",
        "ended": "2023-11-07T05:31:56Z",
        "endReason": "unjoined",
        "firstSpeaker": "FIRST_SPEAKER_AGENT",
        "firstSpeakerSettings": {
          "user": {
            "fallback": {
              "delay": "<string>",
              "text": "<string>"
            }
          },
          "agent": {
            "uninterruptible": true,
            "text": "<string>",
            "delay": "<string>"
          }
        },
        "inactivityMessages": [
          {
            "duration": "<string>",
            "message": "<string>",
            "endBehavior": "END_BEHAVIOR_UNSPECIFIED"
          }
        ],
        "initialOutputMedium": "MESSAGE_MEDIUM_VOICE",
        "joinTimeout": "30s",
        "joinUrl": "<string>",
        "languageHint": "<string>",
        "maxDuration": "3600s",
        "medium": {
          "webRtc": {},
          "twilio": {},
          "serverWebSocket": {
            "inputSampleRate": 123,
            "outputSampleRate": 123,
            "clientBufferSizeMs": 123
          },
          "telnyx": {},
          "plivo": {},
          "exotel": {}
        },
        "model": "fixie-ai/ultravox",
        "recordingEnabled": false,
        "systemPrompt": "<string>",
        "temperature": 0,
        "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
          }
        },
        "transcriptOptional": true,
        "errorCount": 0,
        "vadSettings": {
          "turnEndpointDelay": "<string>",
          "minimumTurnDuration": "<string>",
          "minimumInterruptionDuration": "<string>",
          "frameActivationThreshold": 123
        },
        "shortSummary": "<string>",
        "summary": "<string>",
        "experimentalSettings": "<any>",
        "metadata": {},
        "initialState": {}
      },
      "errorCount": 123
    }
  ],
  "total": 123
}

Authorizations

X-API-Key
string
header
required

API key

Path Parameters

tool_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