List Agents

Returns a list of your agents and their metadata.

page_sizeinteger

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

searchstring nullable

Search by agents name.

archivedboolean nullable

Filter agents by archived status

show_only_owned_agentsboolean

If set to true, the endpoint will omit any agents that were shared with you by someone else and include only the ones you own. Deprecated: use created_by_user_id instead.

created_by_user_idstring nullable

Filter agents by creator user ID. When set, only agents created by this user are returned. Takes precedence over show_only_owned_agents. Use '@me' to refer to the authenticated user.

sort_direction'asc' | 'desc'

The direction to sort the results

sort_by'name' | 'created_at' | 'call_count_7d'

The field to sort the results by

cursorstring nullable

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

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable

The next cursor to paginate through the agents

has_moreboolean required

Whether there are more agents to paginate through

Example response

{
  "agents": [
    {
      "access_info": {
        "creator_email": "john@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      },
      "agent_id": "J3Pbu5gP6NNKBscdCdwB",
      "archived": false,
      "created_at_unix_secs": 1716153600,
      "name": "My Agent",
      "tags": [
        "Customer Support",
        "Technical Help",
        "Eleven"
      ]
    }
  ],
  "has_more": false,
  "next_cursor": "123"
}

v4

List Agents

Query parameters

Headers

Response

Example response