> 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.

# Create flow

POST https://api.runtype.com/v1/flows
Content-Type: application/json

Create a new flow with step definitions.

Reference: https://docs.runtype.com/api-reference/runtype-api/flows/create-flow

## 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

### Body (application/json)

This endpoint expects an object.

- `name` (string, required)
- `description` (string, optional, nullable)
- `flowSteps` (list of V1FlowsPostRequestBodyContentApplicationJsonSchemaFlowStepsItems, optional)
- `steps` (list of V1FlowsPostRequestBodyContentApplicationJsonSchemaStepsItems, optional)

## Response

### 201

Created flow

- `createdAt` (string, required)
- `flowSteps` (list of V1FlowsPostResponsesContentApplicationJsonSchemaFlowStepsItems, required)
- `id` (string, required)
- `lastModifiedSource` (string, required, nullable)
- `name` (string, required)
- `organizationId` (string, required, nullable)
- `updatedAt` (string, required)
- `userId` (string, required)
- `dashboardUrl` (string, optional)
- `description` (string, optional, nullable)
- `draftVersionId` (string, optional, nullable)
- `lastRunAt` (string, optional, nullable)
- `publishedVersionId` (string, optional, nullable)
- `sampleMetadata` (map from string to any, optional)
- `stepCount` (integer, optional)

## Errors

### 400 Bad Request Error

Validation 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.

### 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.

### 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

### V1FlowsPostRequestBodyContentApplicationJsonSchemaFlowStepsItems

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `prompt`, `crawl`, `fetch-url`, `retrieve-record`, `get-record`, `list-records`, `api-call`, `transform-data`, `template`, `conditional`, `loop`, `set-variable`, `upsert-record`, `send-email`, `send-event`, `send-stream`, `update-record`, `search`, `generate-embedding`, `vector-search`, `tool-call`, `wait-until`, `paginate-api`, `store-vector`, `execute-agent`, `store-asset`, `generate-pdf`, `save-memory`, `recall-memory`, `memory-summary`, `extract`
- `config` (any, optional)
- `enabled` (boolean, optional, default: true)
- `id` (string, optional)
- `order` (integer, optional)
- `when` (string, optional)

### V1FlowsPostRequestBodyContentApplicationJsonSchemaStepsItems

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `prompt`, `crawl`, `fetch-url`, `retrieve-record`, `get-record`, `list-records`, `api-call`, `transform-data`, `template`, `conditional`, `loop`, `set-variable`, `upsert-record`, `send-email`, `send-event`, `send-stream`, `update-record`, `search`, `generate-embedding`, `vector-search`, `tool-call`, `wait-until`, `paginate-api`, `store-vector`, `execute-agent`, `store-asset`, `generate-pdf`, `save-memory`, `recall-memory`, `memory-summary`, `extract`
- `config` (any, optional)
- `enabled` (boolean, optional, default: true)
- `id` (string, optional)
- `order` (integer, optional)
- `when` (string, optional)

### V1FlowsPostResponsesContentApplicationJsonSchemaFlowStepsItems

- `id` (string, required)
- `type` (string, required)
- `config` (map from string to any, optional)
- `enabled` (boolean, optional)
- `name` (string, optional)
- `order` (integer, optional)

### 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

**Request**

```json
{
  "name": "Customer Outreach Flow",
  "description": "Automated customer communication workflow",
  "steps": [
    {
      "name": "Generate Greeting",
      "type": "prompt",
      "config": {
        "model": "gpt-4",
        "outputVariable": "greeting",
        "userPrompt": "Generate a personalized greeting for {{customer_name}} from {{company_name}}"
      },
      "enabled": true,
      "id": "greeting",
      "order": 1
    }
  ]
}
```

**Response**

```json
{
  "createdAt": "string",
  "flowSteps": [
    {
      "id": "string",
      "type": "string",
      "config": {},
      "enabled": true,
      "name": "string",
      "order": 1
    }
  ],
  "id": "string",
  "lastModifiedSource": "string",
  "name": "string",
  "organizationId": "string",
  "updatedAt": "string",
  "userId": "string",
  "dashboardUrl": "string",
  "description": "string",
  "draftVersionId": "string",
  "lastRunAt": "string",
  "publishedVersionId": "string",
  "sampleMetadata": {},
  "stepCount": 1
}
```

**SDK Code**

```python Create a Flow
import requests

url = "https://api.runtype.com/v1/flows"

payload = {
    "name": "Customer Outreach Flow",
    "description": "Automated customer communication workflow",
    "steps": [
        {
            "name": "Generate Greeting",
            "type": "prompt",
            "config": {
                "model": "gpt-4",
                "outputVariable": "greeting",
                "userPrompt": "Generate a personalized greeting for {{customer_name}} from {{company_name}}"
            },
            "enabled": True,
            "id": "greeting",
            "order": 1
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Create a Flow
const url = 'https://api.runtype.com/v1/flows';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Customer Outreach Flow","description":"Automated customer communication workflow","steps":[{"name":"Generate Greeting","type":"prompt","config":{"model":"gpt-4","outputVariable":"greeting","userPrompt":"Generate a personalized greeting for {{customer_name}} from {{company_name}}"},"enabled":true,"id":"greeting","order":1}]}'
};

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

```go Create a Flow
package main

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

func main() {

	url := "https://api.runtype.com/v1/flows"

	payload := strings.NewReader("{\n  \"name\": \"Customer Outreach Flow\",\n  \"description\": \"Automated customer communication workflow\",\n  \"steps\": [\n    {\n      \"name\": \"Generate Greeting\",\n      \"type\": \"prompt\",\n      \"config\": {\n        \"model\": \"gpt-4\",\n        \"outputVariable\": \"greeting\",\n        \"userPrompt\": \"Generate a personalized greeting for {{customer_name}} from {{company_name}}\"\n      },\n      \"enabled\": true,\n      \"id\": \"greeting\",\n      \"order\": 1\n    }\n  ]\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 Create a Flow
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/flows")

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  \"name\": \"Customer Outreach Flow\",\n  \"description\": \"Automated customer communication workflow\",\n  \"steps\": [\n    {\n      \"name\": \"Generate Greeting\",\n      \"type\": \"prompt\",\n      \"config\": {\n        \"model\": \"gpt-4\",\n        \"outputVariable\": \"greeting\",\n        \"userPrompt\": \"Generate a personalized greeting for {{customer_name}} from {{company_name}}\"\n      },\n      \"enabled\": true,\n      \"id\": \"greeting\",\n      \"order\": 1\n    }\n  ]\n}"

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

```java Create a Flow
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/flows")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Customer Outreach Flow\",\n  \"description\": \"Automated customer communication workflow\",\n  \"steps\": [\n    {\n      \"name\": \"Generate Greeting\",\n      \"type\": \"prompt\",\n      \"config\": {\n        \"model\": \"gpt-4\",\n        \"outputVariable\": \"greeting\",\n        \"userPrompt\": \"Generate a personalized greeting for {{customer_name}} from {{company_name}}\"\n      },\n      \"enabled\": true,\n      \"id\": \"greeting\",\n      \"order\": 1\n    }\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/flows', [
  'body' => '{
  "name": "Customer Outreach Flow",
  "description": "Automated customer communication workflow",
  "steps": [
    {
      "name": "Generate Greeting",
      "type": "prompt",
      "config": {
        "model": "gpt-4",
        "outputVariable": "greeting",
        "userPrompt": "Generate a personalized greeting for {{customer_name}} from {{company_name}}"
      },
      "enabled": true,
      "id": "greeting",
      "order": 1
    }
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Create a Flow
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/flows");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Customer Outreach Flow\",\n  \"description\": \"Automated customer communication workflow\",\n  \"steps\": [\n    {\n      \"name\": \"Generate Greeting\",\n      \"type\": \"prompt\",\n      \"config\": {\n        \"model\": \"gpt-4\",\n        \"outputVariable\": \"greeting\",\n        \"userPrompt\": \"Generate a personalized greeting for {{customer_name}} from {{company_name}}\"\n      },\n      \"enabled\": true,\n      \"id\": \"greeting\",\n      \"order\": 1\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Create a Flow
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Customer Outreach Flow",
  "description": "Automated customer communication workflow",
  "steps": [
    [
      "name": "Generate Greeting",
      "type": "prompt",
      "config": [
        "model": "gpt-4",
        "outputVariable": "greeting",
        "userPrompt": "Generate a personalized greeting for {{customer_name}} from {{company_name}}"
      ],
      "enabled": true,
      "id": "greeting",
      "order": 1
    ]
  ]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/flows")! 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()
```