List tools

Get all available tools in the workspace.

Headers

xi-api-keystringRequired

Query parameters

searchstring or nullOptional
If specified, the endpoint returns only tools whose names start with this string.
page_sizeinteger or nullOptional1-100
How many documents to return at maximum. Can not exceed 100, defaults to 30.
show_only_owned_documentsbooleanOptionalDefaults to false

If set to true, the endpoint will return only tools owned by you (and not shared from somebody else).

typeslist of enums or nullOptional
If present, the endpoint will return only tools of the given types.
Allowed values:
sort_directionenumOptional
The direction to sort the results
Allowed values:
sort_byenum or nullOptional
The field to sort the results by
Allowed values:
cursorstring or nullOptional
Used for fetching next page. Cursor is returned in the response.

Response

Successful Response
toolslist of objects
has_moreboolean
next_cursorstring or null

Errors