Hoppa till navigering

Lista agenter

Returnerar en lista över dina agenter och deras metadata.

Headers

xi-api-keystringValfri

Frågeparametrar

page_sizeintegerValfri1-100Standard är 30

Maximalt antal agenter att returnera. Får inte överstiga 100, standardvärdet är 30.

searchstring or nullValfri

Sök efter agentens namn.

archivedboolean or nullValfriStandard är false
Filtrera agenter efter arkiveringsstatus
show_only_owned_agentsbooleanValfriStandard är falseDeprecated

Om värdet är true utelämnar endpointen alla agenter som någon annan har delat med dig och inkluderar endast de du äger. Föråldrat: använd created_by_user_id i stället.

created_by_user_idstring or nullValfri

Filtrera agenter efter användar-ID för skaparen. När detta anges returneras endast agenter som skapats av denna användare. Har företräde framför show_only_owned_agents. Använd '@me' för att hänvisa till den autentiserade användaren.

tagslist of strings or nullValfri

Filtrera agenter efter tagg. Upprepa parametern för att matcha någon av flera taggar.

sort_directionenumValfri

Riktningen för att sortera resultaten

Tillåtna värden:
sort_byenum or nullValfri

Fältet att sortera resultaten efter

Tillåtna värden:
cursorstring or nullValfri

Används för att hämta nästa sida. Markören returneras i svaret.

Svar

Lyckat svar
agentslist of objects

En lista över agenter och deras metadata

has_moreboolean
Om det finns fler agenter att paginera igenom
next_cursorstring or nullValfri

Nästa markör för att paginera genom agenterna

Fel

422
Unprocessable Entity Error