Sign in
Tools

Execute Tool

Execute a saved custom tool against the supplied argument values and return its output.

Runtime failures are returned as HTTP 200 with success=False and a clean error message (see :func:execute_tool_inline).

post/workflows/v1/tools/{tool_id}/execute

Path parameters

tool_idstring required
Example:5eb7cf5a86d9755df3a6c593

Request body

argsobject

Argument values to invoke the tool with, keyed by the tool's parameter names.

Response

Successful Response

successboolean required
{"stackTrail":"components:schemas:ToolExecuteResponse:properties:result:anyOf","oasType":"schema","type":"unknown","title":"Result","description":"The tool's return value on success.","nullable":true}
errorstring nullable

Clean error message when success is False.

latency_msinteger nullable

Wall-clock execution time in milliseconds.

Changes