List agents

GET

/v1/convai/agents

GET

/v1/convai/agents

curl -G https://api.elevenlabs.io/v1/convai/agents \
     -d archived=true \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d page_size=1 \
     -d search=search \
     -d show_only_owned_agents=true \
     -d sort_by=name \
     -d sort_direction=asc \
     -d tags=tags

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

Returns a list of your agents and their metadata.

Parametry zapytania

page_sizeintegerOpcjonalny1-100Domyślnie 30

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

searchstringOpcjonalny

Search by agents name.

archivedbooleanOpcjonalny

Filter agents by archived status

show_only_owned_agentsbooleanOpcjonalnyDomyślnie falseDeprecated

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_idstringOpcjonalny

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.

tagsstringOpcjonalny

Filter agents by tag. Repeat the parameter to match any of several tags.

sort_directionenumOpcjonalny

The direction to sort the results

Dozwolone wartości:

sort_byenumOpcjonalny

The field to sort the results by

Dozwolone wartości:

cursorstringOpcjonalny

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

Odpowiedź

Successful Response

agentslist of objects

A list of agents and their metadata

has_moreboolean

Whether there are more agents to paginate through

next_cursorstringOpcjonalny

The next cursor to paginate through the agents

Błędy

422

Agents List Request Unprocessable Entity Error

Nagłówki

Parametry zapytania

Odpowiedź

Błędy