latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Tool

Get tool invocations

Retrieve tool invocations under the specified filters.

Permissions

This endpoint may require the following permission:

  • Conversation:GetInteractionInsights for ToolInvocations from a regular conversation.
  • Simulation:GetSimulationUnitTestSetRun for ToolInvocations from a simulation conversation.
get/v1/{organization}/tool/invocation

Path parameters

organizationstring required

Query parameters

tool_idstring[]

The IDs of the tools to get invocations for.

The IDs of the tools to get invocations for.

versionstring[]

A list of semver constraints that specifies the versions to retrieve in the Python packaging specification. This must be the exact same length as tool_id, and each entry corresponds to the tool ID at the same index.

A list of semver constraints that specifies the versions to retrieve in the Python packaging specification. This must be the exact same length as tool_id, and each entry corresponds to the tool ID at the same index.

invocation_source_typestring[]

The source types of the invocations.

The source types of the invocations.

conversation_idstring[]

The conversation IDs associated with the invocations if they are of invocation source regular-conversation.

The conversation IDs associated with the invocations if they are of invocation source regular-conversation.

simulation_unit_test_set_run_idstring[]

The simulation unit test set run IDs associated with the invocations if they are of invocation source simulation-conversation.

The simulation unit test set run IDs associated with the invocations if they are of invocation source simulation-conversation.

succeededboolean nullable

Whether the invocation succeeded.

Whether the invocation succeeded.

limitinteger

The maximum number of tool invocations to retrieve.

The maximum number of tool invocations to retrieve.

continuation_tokeninteger

The token from the previous request to return the next page of tool invocations.

The token from the previous request to return the next page of tool invocations.

sort_bystring[]

The fields to sort the sets by. Supported fields are created_at, version.major, version.minor, version.patch, tool_id, invocation_source.type, and invocation_status.succeeded. 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 sets by. Supported fields are created_at, version.major, version.minor, version.patch, tool_id, invocation_source.type, and invocation_status.succeeded. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

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 tool invocations to retrieve.

{"stackTrail":"components:schemas:src__app__endpoints__tool__get_tool_invocations__Response:properties:continuation_token:anyOf","oasType":"schema","type":"unknown","title":"Continuation Token","description":"The continuation token to retrieve the next page of tool invocations, or null if there are no more tool invocations.","nullable":true}