Execute tool | Runtype Documentation

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 by default; 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

toolIdstringOptional

Response

Tool execution result (JSON for non-flow tools, SSE stream for flow tools)

executionIdstring

executionTimeMsdouble

statusenum

errorstring

resultany

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/tools/id/execute \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"parameters": {
>	"a": 15,
>	"b": 25,
>	"operation": "add"
>	}
>	}'

1	{
2	"executionId": "string",
3	"executionTimeMs": 1.1,
4	"status": "pending",
5	"error": "string"
6	}