Skip to navigation

Agents weergeven

Retourneert een lijst met je agents en hun metadata.

Headers

xi-api-keystringOptional

Query parameters

page_sizeintegerOptional1-100Defaults to 30

Het maximale aantal Agents dat moet worden geretourneerd. Mag niet meer zijn dan 100; standaard is dit 30.

searchstring or nullOptional
Zoeken op naam van agent.
archivedboolean or nullOptionalDefaults to false
Filter agents op archiefstatus
show_only_owned_agentsbooleanOptionalDefaults to falseDeprecated

Als dit is ingesteld op true, laat het endpoint alle agents weg die iemand anders met je heeft gedeeld en neemt het alleen agents op waarvan jij de eigenaar bent. Verouderd: gebruik in plaats daarvan created_by_user_id.

created_by_user_idstring or nullOptional

Filter agents op gebruikers-ID van de maker. Wanneer ingesteld, worden alleen agents geretourneerd die door deze gebruiker zijn gemaakt. Dit heeft voorrang op show_only_owned_agents. Gebruik ‘@me’ om te verwijzen naar de geverifieerde gebruiker.

tagslist of strings or nullOptional
Filter agents op tag. Herhaal de parameter om een van meerdere tags te matchen.
sort_directionenumOptional
De richting waarin je de resultaten sorteert
Allowed values:
sort_byenum or nullOptional
Het veld waarop de resultaten worden gesorteerd
Allowed values:
cursorstring or nullOptional
Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response
agentslist of objects
Een lijst met agents en hun metadata
has_moreboolean
Of er meer agenten zijn om te pagineren
next_cursorstring or nullOptional
De volgende cursor om door de agents te pagineren

Errors

422
Unprocessable Entity Error