Skip to navigation

Tools ophalen

Haal alle beschikbare tools in de workspace op.

Headers

xi-api-keystringOptional

Query parameters

searchstring or nullOptional
Als dit wordt opgegeven, retourneert het endpoint alleen tools waarvan de naam met deze string begint.
page_sizeinteger or nullOptional1-100

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

show_only_owned_documentsbooleanOptionalDefaults to falseDeprecated

Als dit is ingesteld op true, retourneert het endpoint alleen tools waarvan jij de eigenaar bent, en niet tools die iemand anders heeft gedeeld. Verouderd: gebruik in plaats daarvan created_by_user_id.

created_by_user_idstring or nullOptional

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

typeslist of enums or nullOptional
Als dit aanwezig is, retourneert het endpoint alleen tools van de opgegeven typen.
Allowed values:
sort_directionenumOptional
De richting waarin je de resultaten sorteert
Allowed values:
sort_byenum or nullOptional
Het veld waarop de resultaten worden gesorteerd
Allowed values:
used_by_agent_idstring or nullOptional

Filter op tools waarnaar wordt verwezen door de hoofdbranch van deze agent: tools die aan de agent zijn gekoppeld, tools op gemaakte workflowknooppunten en tools waarnaar procedures verwijzen.

cursorstring or nullOptional
Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response
toolslist of objects
has_moreboolean
next_cursorstring or nullOptional

Errors

422
Unprocessable Entity Error