Agents weergeven

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,
      "updated_at_unix_secs": 1716240000,
      "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"
}

Retourneert een lijst met je agents en hun metadata.

Queryparameters

page_sizeintegerOptioneel1-100Standaard 30

Het maximale aantal Agents dat moet worden geretourneerd. Mag niet meer zijn dan 100; standaard is dit 30.

searchstringOptioneel

Zoeken op naam van agent.

archivedbooleanOptioneel

Filter agents op archiefstatus

show_only_owned_agentsbooleanOptioneelStandaard falseDeprecated

Als dit is ingesteld op true, laat het endpoint alle agents weg die iemand anders met je heeft gedeeld en neemt het alleen agents op waarvan jij de eigenaar bent. Verouderd: gebruik in plaats daarvan created_by_user_id.

created_by_user_idstringOptioneel

Filter agents op gebruikers-ID van de maker. Wanneer ingesteld, worden alleen agents geretourneerd die door deze gebruiker zijn gemaakt. Dit heeft voorrang op show_only_owned_agents. Gebruik ‘@me’ om te verwijzen naar de geverifieerde gebruiker.

tagsstringOptioneel

Filter agents op tag. Herhaal de parameter om een van meerdere tags te matchen.

sort_directionenumOptioneel

De richting waarin je de resultaten sorteert

Toegestane waarden:

sort_byenumOptioneel

Het veld waarop de resultaten worden gesorteerd

Toegestane waarden:

cursorstringOptioneel

Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response

agentslist of objects

Een lijst met agents en hun metadata

has_moreboolean

Of er meer agenten zijn om te pagineren

next_cursorstringOptioneel

De volgende cursor om door de agents te pagineren

Fouten

422

Agents List Request Unprocessable Entity Error

Headers

Queryparameters

Response

Fouten