GET
/
v1
/
convai
/
agents
from elevenlabs import ElevenLabs

client = ElevenLabs(
    api_key="YOUR_API_KEY",
)
client.conversational_ai.get_agents()
{
  "agents": [
    {
      "agent_id": "<string>",
      "name": "<string>",
      "created_at_unix_secs": 123
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

Headers

​
xi-api-key
string

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

Query Parameters

​
cursor
string

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

​
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

Search by agents name.

Response

200
application/json

Successful Response

The response is of type object.