For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • POSTCancel a batch execution
      • POSTSubmit a batch flow execution
      • GETGet batch execution status
      • GETGet batch summary
      • GETGet per-record cost for a batch
      • GETGet step results for a batch record
      • GETGet batch execution total cost
      • GETWebSocket for real-time batch updates
Dashboard
LogoLogo
Runtype APIBatch

Submit a batch flow execution

POST
/v1/batch/flow
POST
/v1/batch/flow
$curl -X POST https://api.runtype.com/v1/batch/flow \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "flowId": "flow_01jv0000000000000000000001",
>  "options": {
>    "maxRetries": 3,
>    "recordConcurrency": 10
>  },
>  "recordIds": [
>    "record_01jv0000000000000000000001",
>    "record_01jv0000000000000000000002",
>    "record_01jv0000000000000000000003"
>  ]
>}'
1{
2  "batchExecutionId": "string",
3  "status": "string"
4}
Submits a batch of records for flow execution. Checks daily execution limits and feature gating.
Was this page helpful?
Previous

Get batch execution status

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

Batch flow request body

Response

Batch submitted
batchExecutionIdstring
statusstring

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error