Zur Navigation springen

Tools abrufen

Alle verfügbaren Tools im Workspace abrufen.

Header

xi-api-keystringOptional

Abfrageparameter

searchstring or nullOptional

Falls angegeben, gibt der Endpunkt nur Tools zurück, deren Namen mit dieser Zeichenfolge beginnen.

page_sizeinteger or nullOptional1-100

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

show_only_owned_documentsbooleanOptionalStandardwert ist falseDeprecated

Wenn auf true gesetzt, gibt der Endpunkt nur Tools zurück, die Ihnen gehören und nicht von anderen freigegeben wurden. Veraltet: Verwenden Sie stattdessen created_by_user_id.

created_by_user_idstring or nullOptional

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

typeslist of enums or nullOptional

Falls vorhanden, gibt der Endpunkt nur Tools der angegebenen Typen zurück.

Erlaubte Werte:
sort_directionenumOptional
Die Richtung zum Sortieren der Ergebnisse
Erlaubte Werte:
sort_byenum or nullOptional
Das Feld, nach dem die Ergebnisse sortiert werden
Erlaubte Werte:
used_by_agent_idstring or nullOptional

Filtert nach Tools, auf die im Hauptzweig dieses Agenten verwiesen wird: dem Agenten zugeordnete Tools, Tools in erstellten Workflow-Knoten und Tools, auf die in Prozeduren verwiesen wird.

cursorstring or nullOptional

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

Antwort

Erfolgreiche Antwort
toolslist of objects
has_moreboolean
next_cursorstring or nullOptional

Fehler

422
Unprocessable Entity Error