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

Get batch execution status

GET
/v1/batch/status/:id
GET
/v1/batch/status/:id
$curl https://api.runtype.com/v1/batch/status/id \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "batchExecutionId": "b7f3c9d2-4a1e-4f8a-9c3e-2d5a7f6b8e9c",
3  "failedRecords": 2,
4  "flowId": "flow_9a8b7c6d5e4f3g2h1i0j",
5  "processedRecords": 50,
6  "startedAt": "2024-06-10T15:30:00Z",
7  "status": "completed",
8  "totalRecords": 50,
9  "completedAt": "2024-06-10T16:45:00Z",
10  "progress": 100,
11  "results": [
12    null
13  ],
14  "successCount": 48
15}
Returns the current status and progress of a batch execution.
Was this page helpful?
Previous

Get batch summary

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
Batch execution ID

Response

Batch status
batchExecutionIdstring
failedRecordsinteger
flowIdstring
processedRecordsinteger
startedAtstring
statusstring
totalRecordsinteger
completedAtstring
progressinteger
resultslist of any
successCountinteger

Errors

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