Vai alla navigazione
ElevenAgentsAgenti

Elenca agenti

Restituisce un elenco dei tuoi agenti e dei relativi metadati.

Header

xi-api-keystringOpzionale

Parametri di query

page_sizeintegerOpzionale1-100Predefinito a 30

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

searchstring or nullOpzionale
Cerca per nome degli agenti.
archivedboolean or nullOpzionalePredefinito a false
Filtra gli agenti in base allo stato di archiviazione
show_only_owned_agentsbooleanOpzionalePredefinito a falseDeprecated

Se impostato su true, l'endpoint ometterà gli agenti condivisi con te da altri e includerà solo quelli di tua proprietà. Deprecato: usa invece created_by_user_id.

created_by_user_idstring or nullOpzionale

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

tagslist of strings or nullOpzionale

Filtra gli agenti in base al tag. Ripeti il parametro per trovare una corrispondenza con uno qualsiasi di più tag.

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:
cursorstring or nullOpzionale
Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.

Risposta

Risposta riuscita
agentslist of objects
Un elenco di agenti e dei relativi metadati.
has_moreboolean
Indica se ci sono altri agenti da visualizzare tramite paginazione
next_cursorstring or nullOpzionale
Il cursore successivo per paginare gli agenti

Errori

422
Unprocessable Entity Error