Create flow | Runtype Documentation

curl -X POST https://api.runtype.com/v1/flows \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "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
    }
  ]
}'

{
  "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",
  "lastRunAt": "string",
  "sampleMetadata": {},
  "stepCount": 1
}

Create a new flow with step definitions.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

namestringRequired>=1 character

descriptionstring or nullOptional<=5000 characters

flowStepslist of objectsOptional

stepslist of objectsOptional

Response

Created flow

createdAtstring

flowStepslist of objects

idstring

lastModifiedSourcestring or null

namestring

organizationIdstring or null

updatedAtstring

userIdstring

dashboardUrlstringOptional

descriptionstring or nullOptional

lastRunAtstring or nullOptional

sampleMetadatamap from strings to anyOptional

stepCountintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error