GET
/
api
/
calls
/
{call_id}
/
messages
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/calls/{call_id}/messages \
  --header 'X-API-Key: <api-key>'
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "role": "MESSAGE_ROLE_UNSPECIFIED",
      "text": "<string>",
      "invocationId": "<string>",
      "toolName": "<string>",
      "errorDetails": "<string>",
      "medium": "MESSAGE_MEDIUM_UNSPECIFIED",
      "callStageMessageIndex": 123,
      "callStageId": "<string>",
      "callState": {},
      "timespan": {
        "start": "<string>",
        "end": "<string>"
      }
    }
  ],
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
call_id
string<uuid>
required

Query Parameters

​
cursor
string

The pagination cursor value.

​
mode
enum<string>
default:last_stage
  • last_stage - Returns all messages for the call's last stage, similar to most call fields
  • in_call - Returns messages from all stages, excluding initialMessages
Available options:
last_stage,
in_call
​
pageSize
integer

Number of results to return per page.

Response

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

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

​
previous
string<uri> | null
Example:

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

​
total
integer
Example:

123