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 summary

GET
/v1/batch/summary
GET
/v1/batch/summary
$curl https://api.runtype.com/v1/batch/summary \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "activeBatches": 2,
3  "batches": [
4    {
5      "failedRecords": 3,
6      "flowName": "User Data Import",
7      "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
8      "processedRecords": 97,
9      "progress": 75,
10      "startedAt": "2024-06-10T09:15:00Z",
11      "status": "running",
12      "totalRecords": 130
13    }
14  ],
15  "recent": [
16    {
17      "failedRecords": 0,
18      "flowName": "Monthly Report Generation",
19      "id": "f1234567-89ab-cdef-0123-456789abcdef",
20      "processedRecords": 500,
21      "progress": 100,
22      "startedAt": "2024-06-09T22:00:00Z",
23      "status": "completed",
24      "totalRecords": 500
25    }
26  ],
27  "recentlyCompleted": 5
28}
Returns a summary of active and recently completed batch executions for the current user.
Was this page helpful?
Previous

Get per-record cost for a batch

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Response

Batch summary
activeBatchesinteger
batcheslist of objects
recentlist of objects
recentlyCompletedinteger

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error