Agents auflisten

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

Header

xi-api-keystringOptional

Abfrageparameter

page_sizeintegerOptional1-100Standardwert ist 30

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

searchstring or nullOptional
Nach Agentenname suchen.
archivedboolean or nullOptionalStandardwert ist false
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_idstring or nullOptional

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.

tagslist of strings or nullOptional
Agenten nach Tag filtern. Wiederholen Sie den Parameter, um mehrere Tags abzugleichen.
sort_directionenumOptional
Die Richtung zum Sortieren der Ergebnisse
Erlaubte Werte:
sort_byenum or nullOptional
Das Feld, nach dem die Ergebnisse sortiert werden
Erlaubte Werte:
cursorstring or nullOptional

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_cursorstring or nullOptional

Der nächste Cursor zum Durchblättern der Agenten

Fehler

422
Unprocessable Entity Error