Vai alla navigazione

Recupera strumenti

Ottieni tutti gli strumenti disponibili nel workspace.

Header

xi-api-keystringOpzionale

Parametri di query

searchstring or nullOpzionale
Se specificato, l'endpoint restituisce solo gli strumenti i cui nomi iniziano con questa stringa.
page_sizeinteger or nullOpzionale1-100

Numero massimo di documenti da restituire. Non può superare 100; il valore predefinito è 30.

show_only_owned_documentsbooleanOpzionalePredefinito a falseDeprecated

Se impostato su true, l'endpoint restituirà solo gli strumenti di tua proprietà, non condivisi da altri. Deprecato: usa invece created_by_user_id.

created_by_user_idstring or nullOpzionale

Filtra gli strumenti in base all'ID dell'utente creatore. Se impostato, vengono restituiti solo gli strumenti creati da questo utente. Ha la precedenza su show_only_owned_documents. Usa '@me' per fare riferimento all'utente autenticato.

typeslist of enums or nullOpzionale

Se presente, l'endpoint restituirà solo strumenti dei tipi specificati.

Valori consentiti:
sort_directionenumOpzionale
La direzione per ordinare i risultati
Valori consentiti:
sort_byenum or nullOpzionale
Il campo in base al quale ordinare i risultati
Valori consentiti:
used_by_agent_idstring or nullOpzionale

Filtra gli strumenti a cui fa riferimento il branch principale di questo agente: strumenti associati all'agente, strumenti nei nodi del workflow creati e strumenti a cui fanno riferimento le procedure.

cursorstring or nullOpzionale
Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.

Risposta

Risposta riuscita
toolslist of objects
has_moreboolean
next_cursorstring or nullOpzionale

Errori

422
Unprocessable Entity Error