Run flow on records of a type | Runtype Documentation

curl -X POST https://api.runtype.com/v1/flows/id/run-on-record-type \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "recordType": "customer"
}'

{
  "success": true,
  "batchId": "batch_9f8b7c6d5e4a3b2c1d0e",
  "flowId": "flow_123abc456def789ghi",
  "recordType": "customer",
  "recordCount": 5,
  "status": "completed",
  "executedImmediately": true,
  "successCount": 4,
  "failureCount": 1,
  "completedAt": "2024-06-10T15:45:30Z",
  "results": [
    {
      "recordId": "cust_001",
      "recordName": "Acme Corporation",
      "success": true,
      "executionId": "exec_789xyz123abc",
      "executionTime": 2.3,
      "contextSteps": 3,
      "promptsExecuted": 2,
      "error": ""
    },
    {
      "recordId": "cust_002",
      "recordName": "Beta Industries",
      "success": true,
      "executionId": "exec_456def789ghi",
      "executionTime": 1.8,
      "contextSteps": 2,
      "promptsExecuted": 2,
      "error": ""
    },
    {
      "recordId": "cust_003",
      "recordName": "Gamma LLC",
      "success": false,
      "executionId": "exec_123abc456def",
      "executionTime": 0.9,
      "contextSteps": 1,
      "promptsExecuted": 1,
      "error": "Timeout error during execution"
    },
    {
      "recordId": "cust_004",
      "recordName": "Delta Co",
      "success": true,
      "executionId": "exec_321cba654fed",
      "executionTime": 2,
      "contextSteps": 3,
      "promptsExecuted": 2,
      "error": ""
    },
    {
      "recordId": "cust_005",
      "recordName": "Epsilon Enterprises",
      "success": true,
      "executionId": "exec_654fed321cba",
      "executionTime": 1.5,
      "contextSteps": 2,
      "promptsExecuted": 2,
      "error": ""
    }
  ]
}

curl -X POST https://api.runtype.com/v1/flows/id/run-on-record-type \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "recordType": "customer"
}'

{
  "success": true,
  "batchId": "batch_9f8b7c6d5e4a3b2c1d0e",
  "flowId": "flow_123abc456def789ghi",
  "recordType": "customer",
  "recordCount": 5,
  "status": "completed",
  "executedImmediately": true,
  "successCount": 4,
  "failureCount": 1,
  "completedAt": "2024-06-10T15:45:30Z",
  "results": [
    {
      "recordId": "cust_001",
      "recordName": "Acme Corporation",
      "success": true,
      "executionId": "exec_789xyz123abc",
      "executionTime": 2.3,
      "contextSteps": 3,
      "promptsExecuted": 2,
      "error": ""
    },
    {
      "recordId": "cust_002",
      "recordName": "Beta Industries",
      "success": true,
      "executionId": "exec_456def789ghi",
      "executionTime": 1.8,
      "contextSteps": 2,
      "promptsExecuted": 2,
      "error": ""
    },
    {
      "recordId": "cust_003",
      "recordName": "Gamma LLC",
      "success": false,
      "executionId": "exec_123abc456def",
      "executionTime": 0.9,
      "contextSteps": 1,
      "promptsExecuted": 1,
      "error": "Timeout error during execution"
    },
    {
      "recordId": "cust_004",
      "recordName": "Delta Co",
      "success": true,
      "executionId": "exec_321cba654fed",
      "executionTime": 2,
      "contextSteps": 3,
      "promptsExecuted": 2,
      "error": ""
    },
    {
      "recordId": "cust_005",
      "recordName": "Epsilon Enterprises",
      "success": true,
      "executionId": "exec_654fed321cba",
      "executionTime": 1.5,
      "contextSteps": 2,
      "promptsExecuted": 2,
      "error": ""
    }
  ]
}

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

successboolean

batchIdstring

flowIdstring

recordTypestring

recordCountinteger

statusenum

Allowed values:

executedImmediatelyboolean

successCountinteger

failureCountinteger

completedAtstring

resultslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/flows/id/run-on-record-type \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"recordType": "customer"
>	}'

1	{
2	"success": true,
3	"batchId": "batch_9f8b7c6d5e4a3b2c1d0e",
4	"flowId": "flow_123abc456def789ghi",
5	"recordType": "customer",
6	"recordCount": 5,
7	"status": "completed",
8	"executedImmediately": true,
9	"successCount": 4,
10	"failureCount": 1,
11	"completedAt": "2024-06-10T15:45:30Z",
12	"results": [
13	{
14	"recordId": "cust_001",
15	"recordName": "Acme Corporation",
16	"success": true,
17	"executionId": "exec_789xyz123abc",
18	"executionTime": 2.3,
19	"contextSteps": 3,
20	"promptsExecuted": 2,
21	"error": ""
22	},
23	{
24	"recordId": "cust_002",
25	"recordName": "Beta Industries",
26	"success": true,
27	"executionId": "exec_456def789ghi",
28	"executionTime": 1.8,
29	"contextSteps": 2,
30	"promptsExecuted": 2,
31	"error": ""
32	},
33	{
34	"recordId": "cust_003",
35	"recordName": "Gamma LLC",
36	"success": false,
37	"executionId": "exec_123abc456def",
38	"executionTime": 0.9,
39	"contextSteps": 1,
40	"promptsExecuted": 1,
41	"error": "Timeout error during execution"
42	},
43	{
44	"recordId": "cust_004",
45	"recordName": "Delta Co",
46	"success": true,
47	"executionId": "exec_321cba654fed",
48	"executionTime": 2,
49	"contextSteps": 3,
50	"promptsExecuted": 2,
51	"error": ""
52	},
53	{
54	"recordId": "cust_005",
55	"recordName": "Epsilon Enterprises",
56	"success": true,
57	"executionId": "exec_654fed321cba",
58	"executionTime": 1.5,
59	"contextSteps": 2,
60	"promptsExecuted": 2,
61	"error": ""
62	}
63	]
64	}