ElevenAgentsAgents

Wyświetl agentów

Zwraca listę twoich agentów i ich metadane.

Nagłówki

xi-api-keystringOpcjonalny

Parametry zapytania

page_sizeintegerOpcjonalny1-100Domyślnie 30

Maksymalna liczba agentów do zwrócenia. Nie może przekraczać 100, domyślnie 30.

searchstring or nullOpcjonalny
Wyszukaj po nazwie agenta.
archivedboolean or nullOpcjonalnyDomyślnie false

Filtruj agentów według statusu archiwizacji

show_only_owned_agentsbooleanOpcjonalnyDomyślnie falseDeprecated

Jeśli ustawiono true, endpoint pominie agentów udostępnionych ci przez inne osoby i uwzględni tylko tych, których jesteś właścicielem. Przestarzałe: użyj zamiast tego created_by_user_id.

created_by_user_idstring or nullOpcjonalny

Filtruj agentów według ID użytkownika, który ich utworzył. Jeśli ustawione, zwracani są tylko agenci utworzeni przez tego użytkownika. Ma pierwszeństwo przed show_only_owned_agents. Użyj ‘@me’, aby wskazać uwierzytelnionego użytkownika.

tagslist of strings or nullOpcjonalny

Filtruj agentów według tagu. Powtórz parametr, aby dopasować dowolny z kilku tagów.

sort_directionenumOpcjonalny

Kierunek sortowania wyników

Dozwolone wartości:
sort_byenum or nullOpcjonalny

Pole, według którego sortować wyniki

Dozwolone wartości:
cursorstring or nullOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

Odpowiedź

Pomyślna odpowiedź

agentslist of objects

Lista agentów i ich metadanych.

has_moreboolean

Czy są kolejni agenci do wyświetlenia na następnych stronach

next_cursorstring or nullOpcjonalny

Kolejny kursor do stronicowania listy agentów

Błędy

422
Unprocessable Entity Error