Hoppa till navigering

Hämta verktyg

Hämta alla tillgängliga verktyg i workspace.

Headers

xi-api-keystringValfri

Frågeparametrar

searchstring or nullValfri

Om angivet returnerar endpointen endast verktyg vars namn börjar med denna sträng.

page_sizeinteger or nullValfri1-100

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

show_only_owned_documentsbooleanValfriStandard är falseDeprecated

Om värdet är true returnerar endpointen endast verktyg som du äger, och inte sådana som delats av någon annan. Föråldrat: använd created_by_user_id i stället.

created_by_user_idstring or nullValfri

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

typeslist of enums or nullValfri
Om angivet returnerar endpointen endast verktyg av de angivna typerna.
Tillåtna värden:
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:
used_by_agent_idstring or nullValfri

Filtrera till verktyg som refereras av agentens huvudgren: verktyg kopplade till agenten, verktyg på skapade workflow-noder och verktyg som refereras av procedurer.

cursorstring or nullValfri

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

Svar

Lyckat svar
toolslist of objects
has_moreboolean
next_cursorstring or nullValfri

Fel

422
Unprocessable Entity Error