Agents auflisten

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"
}

Gibt eine Liste Ihrer Agenten und ihrer Metadaten zurück.

Abfrageparameter

page_sizeintegerOptional1-100Standardwert ist 30

Maximale Anzahl zurückzugebender Agenten. Darf 100 nicht überschreiten, Standardwert ist 30.

searchstringOptional

Nach Agentenname suchen.

archivedbooleanOptional

Agenten nach Archivstatus filtern

show_only_owned_agentsbooleanOptionalStandardwert ist falseDeprecated

Wenn auf true gesetzt, lässt der Endpunkt alle Agenten aus, die Ihnen von anderen freigegeben wurden, und enthält nur Ihre eigenen. Veraltet: Verwenden Sie stattdessen created_by_user_id.

created_by_user_idstringOptional

Agenten nach Benutzer-ID des Erstellers filtern. Wenn festgelegt, werden nur von diesem Nutzer erstellte Agenten zurückgegeben. Hat Vorrang vor show_only_owned_agents. Verwenden Sie ‘@me’ für den authentifizierten Nutzer.

tagsstringOptional

Agenten nach Tag filtern. Wiederholen Sie den Parameter, um mehrere Tags abzugleichen.

sort_directionenumOptional

Die Richtung zum Sortieren der Ergebnisse

Erlaubte Werte:

sort_byenumOptional

Das Feld, nach dem die Ergebnisse sortiert werden

Erlaubte Werte:

cursorstringOptional

Wird zum Abrufen der nächsten Seite verwendet. Der Cursor wird in der Antwort zurückgegeben.

Antwort

Erfolgreiche Antwort

agentslist of objects

Eine Liste von Agenten und ihren Metadaten

has_moreboolean

Ob weitere Agenten für die Paginierung vorhanden sind.

next_cursorstringOptional

Der nächste Cursor zum Durchblättern der Agenten

Fehler

422

Agents List Request Unprocessable Entity Error

Header

Abfrageparameter

Antwort

Fehler