Sign in

v19

latestOpenAPI 3.0.3raw.githubusercontent.com2025-06-29204858.4 KB
Tool

Execute tool

Execute a tool with a given input. The input is validated against the tool's input schema.

post/v1/tools/{id}/execute

Path parameters

idstring required

Request body

{"stackTrail":"components:schemas:ExecuteToolRequest:properties:input","oasType":"schema","type":"unknown","description":"The input to the tool. This must be a valid JSON-serializable object. It will be validated against the tool's input schema."}
revision_idstring

The Tool revision ID to execute. This optional parmeter is used to pin executions to specific versions of the Tool. If not provided, the latest (current) version of the Tool will be executed.

Response

OK

{"stackTrail":"components:schemas:ExecuteToolResponse:properties:output","oasType":"schema","type":"unknown","description":"The returned value of the Tool's execute function."}
output_status'error' | 'json_serialization_error' | 'valid' required

The status of the output. "valid" means your Tool executed successfully and returned a valid JSON-serializable object, or void. "json_serialization_error" means your Tool executed successfully, but returned a nonserializable object. "error" means your Tool failed to execute.