Sign in

v4

latestOpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Get Tool Executions

Get paginated list of tool executions for a specific tool.

get/v1/convai/tools/{tool_id}/executions

Path parameters

tool_idstring required

ID of the requested tool.

ID of the requested tool.

Query parameters

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Used for fetching next page. Cursor is returned in the response.

page_sizeinteger

How many documents to return at maximum. Can not exceed 100, defaults to 30.

How many documents to return at maximum. Can not exceed 100, defaults to 30.

is_errorboolean nullable

Filter by error status. If not provided, returns all executions.

Filter by error status. If not provided, returns all executions.

agent_idstring nullable

Filter by agent ID.

Filter by agent ID.

branch_idstring nullable

Filter by agent branch ID.

Filter by agent branch ID.

start_timenumber nullable

Filter executions from this Unix timestamp (inclusive).

Filter executions from this Unix timestamp (inclusive).

end_timenumber nullable

Filter executions until this Unix timestamp (inclusive).

Filter executions until this Unix timestamp (inclusive).

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable
has_moreboolean required