Skip to main content
GET
/
v1
/
voiceai
/
agents
List Agents
curl --request GET \
  --url https://api.example.com/v1/voiceai/agents \
  --header 'x-api-key: <api-key>'
{
  "agents": [
    {
      "agent_id": "<string>",
      "name": "<string>",
      "created_at_unix_secs": 123,
      "access_info": {
        "is_creator": true,
        "creator_name": "<string>",
        "creator_email": "<string>",
        "role": "admin"
      },
      "tags": [
        "<string>"
      ],
      "last_call_time_unix_secs": 123,
      "archived": false
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for programmatic access

Query Parameters

page_size
integer
default:30

How many Agents to return at maximum. Can not exceed 100, defaults to 30.

Required range: 1 <= x <= 100
search
string | null

Search by agents name.

archived
boolean | null
default:false

Filter agents by archived status

sort_direction
enum<string>
default:desc

The direction to sort the results

Available options:
asc,
desc
sort_by
enum<string> | null

The field to sort the results by

Available options:
name,
created_at
cursor
string | null

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

agents
AgentSummaryResponseModel · object[]
required

A list of agents and their metadata

has_more
boolean
required

Whether there are more agents to paginate through

next_cursor
string | null

The next cursor to paginate through the agents