Skip to main content
GET
/
api
/
agents
/
{agent_id}
/
scheduled_batches
cURL
curl --request GET \
  --url https://api.ultravox.ai/api/agents/{agent_id}/scheduled_batches \
  --header 'X-API-Key: <api-key>'
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "windowStart": "2023-11-07T05:31:56Z",
      "windowEnd": "2023-11-07T05:31:56Z",
      "webhookUrl": "<string>",
      "webhookSecret": "<string>",
      "paused": true,
      "totalCount": 123,
      "completedCount": 123,
      "endedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key

Path Parameters

​
agent_id
string<uuid>
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<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