Run flow on records of a type | Runtype Documentation

{
  "batchId": "batch_9f8c7d6e5b4a3c2d1e0f",
  "completedAt": "2024-06-10T15:45:30Z",
  "executedImmediately": true,
  "failureCount": 0,
  "flowId": "flow_123abc456def789ghi",
  "recordCount": 5,
  "recordType": "customer",
  "results": [
    {
      "recordId": "cust_9876543210",
      "recordName": "Acme Corporation",
      "success": true,
      "contextSteps": 3,
      "error": "",
      "executionId": "exec_001a2b3c4d5e6f7g8h9i",
      "executionTime": 0.85,
      "promptsExecuted": 2
    },
    {
      "recordId": "cust_1234567890",
      "recordName": "Beta Industries",
      "success": true,
      "contextSteps": 2,
      "error": "",
      "executionId": "exec_002b3c4d5e6f7g8h9i0j",
      "executionTime": 0.78,
      "promptsExecuted": 2
    },
    {
      "recordId": "cust_1122334455",
      "recordName": "Gamma LLC",
      "success": true,
      "contextSteps": 1,
      "error": "",
      "executionId": "exec_003c4d5e6f7g8h9i0j1k",
      "executionTime": 0.92,
      "promptsExecuted": 1
    },
    {
      "recordId": "cust_6677889900",
      "recordName": "Delta Co",
      "success": true,
      "contextSteps": 2,
      "error": "",
      "executionId": "exec_004d5e6f7g8h9i0j1k2l",
      "executionTime": 0.88,
      "promptsExecuted": 2
    },
    {
      "recordId": "cust_5544332211",
      "recordName": "Epsilon Enterprises",
      "success": true,
      "contextSteps": 1,
      "error": "",
      "executionId": "exec_005e6f7g8h9i0j1k2l3m",
      "executionTime": 0.8,
      "promptsExecuted": 1
    }
  ],
  "status": "completed",
  "success": true,
  "successCount": 5
}

Execute a flow against every record of the given type. Small batches (≤10) execute immediately and return 200; larger batches return 202 with a scheduled batchId.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

recordTypestringRequired>=1 character

Response

Batch executed immediately

batchIdstring

completedAtstring

executedImmediatelyboolean

failureCountinteger

flowIdstring

recordCountinteger

recordTypestring

resultslist of objects

statusenum

Allowed values:

successboolean

successCountinteger

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error