Execute a flow or agent

POST

/v1/dispatch

POST

/v1/dispatch

$ curl -X POST https://api.runtype.com/v1/dispatch \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "flow": {
>     "name": "Sales Analysis",
>     "steps": [
>       {
>         "config": {
>           "model": "gpt-4",
>           "outputVariable": "sales_analysis",
>           "responseFormat": "markdown",
>           "userPrompt": "Analyze the sales performance for {{_record.metadata.quarter}} in {{_record.metadata.region}}."
>         },
>         "enabled": true,
>         "id": "analyze-sales",
>         "name": "Analyze Sales Performance",
>         "order": 1,
>         "type": "prompt"
>       }
>     ]
>   },
>   "options": {
>     "autoAppendMetadata": true,
>     "flowMode": "virtual",
>     "recordMode": "virtual",
>     "streamResponse": true
>   },
>   "record": {
>     "metadata": {
>       "growth_rate": "18%",
>       "quarter": "Q4 2024",
>       "region": "North America",
>       "sales_team": "Team Alpha",
>       "top_products": [
>         "Product A",
>         "Product B",
>         "Product C"
>       ],
>       "total_revenue": "$2.5M"
>     },
>     "name": "Q4 Sales Report",
>     "type": "report"
>   }
> }'

Main dispatch endpoint for flow and agent execution with record resolution. Supports streaming via SSE or synchronous JSON responses. Send the RFC 7240 Prefer: respond-async header to run a Claude Managed durable-lane turn (a saved agent dispatched with a conversationId) fire-and-forget: the response is a 202 handle and the turn runs headlessly (reconnect via the executions events stream or poll the runs API).

Main dispatch endpoint for flow and agent execution with record resolution. Supports streaming via SSE or synchronous JSON responses. Send the RFC 7240 `Prefer: respond-async` header to run a Claude Managed durable-lane turn (a saved agent dispatched with a conversationId) fire-and-forget: the response is a 202 handle and the turn runs headlessly (reconnect via the executions events stream or poll the runs API).

Authentication

AuthorizationBearer

API key or Clerk session token

Request

Dispatch request body (see DispatchRequestSchema)

Response

Execution result (SSE stream or JSON)

object

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error