> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Run flow on records of a type

POST https://api.runtype.com/v1/flows/{id}/run-on-record-type
Content-Type: application/json

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.

Reference: https://docs.runtype.com/api-reference/runtype-api/flows/run-flow-on-records-of-a-type

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)

### Body (application/json)

This endpoint expects an object.

- `recordType` (string, required)

## Response

### 200

Batch executed immediately

- `batchId` (string, required)
- `completedAt` (string, required)
- `executedImmediately` (boolean, required)
- `failureCount` (integer, required)
- `flowId` (string, required)
- `recordCount` (integer, required)
- `recordType` (string, required)
- `results` (list of V1FlowsIdRunOnRecordTypePostResponsesContentApplicationJsonSchemaResultsItems, required)
- `status` (enum, required)
  - Allowed values: `scheduled`
- `success` (boolean, required)
- `successCount` (integer, required)

### 202

Batch scheduled for execution

- `batchId` (string, required)
- `flowId` (string, required)
- `message` (string, required)
- `recordCount` (integer, required)
- `recordType` (string, required)
- `records` (list of V1FlowsIdRunOnRecordTypePostResponsesContentApplicationJsonSchemaRecordsItems, required)
- `scheduledAt` (string, required)
- `status` (enum, required)
  - Allowed values: `scheduled`
- `success` (boolean, required)

## Errors

### 400 Bad Request Error

Validation error or no matching records

- `error` (string, required)
- `details` (list of string, optional)
- `recordCount` (integer, optional)
- `recordType` (string, optional)

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Flow not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 422 Unprocessable Entity Error

Flow requires behavior not supported by the runtime execution surface

- `code` (enum, required)
  - Allowed values: `RUNTIME_FLOW_UNSUPPORTED`
- `error` (string, required)
- `reasons` (list of string, required)

### 429 Too Many Requests Error

Daily execution limit exceeded

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1FlowsIdRunOnRecordTypePostResponsesContentApplicationJsonSchemaResultsItems

- `recordId` (string, required)
- `recordName` (string, required, nullable)
- `success` (boolean, required)
- `contextSteps` (integer, optional)
- `error` (string, optional)
- `executionId` (string, optional)
- `executionTime` (double, optional)
- `promptsExecuted` (integer, optional)

### V1FlowsIdRunOnRecordTypePostResponsesContentApplicationJsonSchemaRecordsItems

- `id` (string, required)
- `name` (string, required, nullable)
- `type` (string, required)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

## Examples

### Example 1

**Request**

```json
{
  "recordType": "string"
}
```

**Response**

```json
{
  "batchId": "string",
  "completedAt": "string",
  "executedImmediately": true,
  "failureCount": 1,
  "flowId": "string",
  "recordCount": 1,
  "recordType": "string",
  "results": [
    {
      "recordId": "string",
      "recordName": "string",
      "success": true,
      "contextSteps": 1,
      "error": "string",
      "executionId": "string",
      "executionTime": 1.1,
      "promptsExecuted": 1
    }
  ],
  "status": "completed",
  "success": true,
  "successCount": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/flows/id/run-on-record-type"

payload = { "recordType": "string" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/flows/id/run-on-record-type';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"recordType":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/flows/id/run-on-record-type"

	payload := strings.NewReader("{\n  \"recordType\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/flows/id/run-on-record-type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recordType\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/flows/id/run-on-record-type")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recordType\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/flows/id/run-on-record-type', [
  'body' => '{
  "recordType": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/flows/id/run-on-record-type");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"recordType\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["recordType": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/flows/id/run-on-record-type")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Request**

```json
{
  "recordType": "string"
}
```

**Response**

```json
{
  "batchId": "string",
  "completedAt": "string",
  "executedImmediately": true,
  "failureCount": 1,
  "flowId": "string",
  "recordCount": 1,
  "recordType": "string",
  "results": [
    {
      "recordId": "string",
      "recordName": "string",
      "success": true,
      "contextSteps": 1,
      "error": "string",
      "executionId": "string",
      "executionTime": 1.1,
      "promptsExecuted": 1
    }
  ],
  "status": "completed",
  "success": true,
  "successCount": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/flows/id/run-on-record-type"

payload = { "recordType": "string" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/flows/id/run-on-record-type';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"recordType":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/flows/id/run-on-record-type"

	payload := strings.NewReader("{\n  \"recordType\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/flows/id/run-on-record-type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recordType\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/flows/id/run-on-record-type")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recordType\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/flows/id/run-on-record-type', [
  'body' => '{
  "recordType": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/flows/id/run-on-record-type");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"recordType\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["recordType": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/flows/id/run-on-record-type")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```