Skip to navigation
Runtype APITools

Execute tool

Execute a tool by ID with the provided parameters. Non-flow tools return the documented JSON result. Flow tools return a text/event-stream response whose frames use the ExecutionStreamEvent vocabulary; use a raw/streaming client helper for flow tools.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.
parametersmap from strings to anyRequired
contextobjectOptional
toolConfigmap from strings to anyOptional

Built-in tools only: the instance config an agent’s toolConfigs entry would carry, validated against the tool’s configSchema. Rejected for a saved tool.

toolIdstringOptional

Response

Tool execution result: BuiltinToolExecuteResult for a builtin: or platform: id, ExecuteToolResult for a saved non-flow tool, an SSE stream for a flow tool

BuiltinToolExecuteResultobject
OR
object

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error