Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Tool

Get tools

get/v1/{organization}/tool/

Path parameters

organizationstring required

Query parameters

idstring[]

The IDs of the tools to retrieve.

The IDs of the tools to retrieve.

deprecatedboolean nullable

Whether the tools are deprecated.

Whether the tools are deprecated.

sort_bystring[]

The fields to sort the versions by. Supported fields are name and deprecated. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

The fields to sort the versions by. Supported fields are name and deprecated. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

tagstring[]

The tags of the simulation personas. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

The tags of the simulation personas. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

limitinteger

The maximum number of tools to return.

The maximum number of tools to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of tools.

The continuation token from the previous request used to retrieve the next page of tools.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more tools to retrieve.

{"stackTrail":"components:schemas:src__app__endpoints__tool__get_tools__Response:properties:continuation_token:anyOf","oasType":"schema","type":"unknown","title":"Continuation Token","description":"A token to supply to the next request to retrieve the next page of tools. Only populated if `has_more` is `True`.","nullable":true}