Update flow | Runtype Documentation

curl -X PUT https://api.runtype.com/v1/flows/id \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "flowSteps": [
    {
      "name": "Analyze Input",
      "type": "prompt",
      "config": {
        "model": "claude-sonnet-4-5",
        "outputVariable": "analysis",
        "responseFormat": "text",
        "systemPrompt": "You are a helpful assistant.",
        "userPrompt": "Analyze the following: {{input}}"
      },
      "enabled": true,
      "order": 0
    },
    {
      "name": "Format Output",
      "type": "transform-data",
      "config": {
        "outputVariable": "result",
        "script": "return { summary: variables.analysis }"
      },
      "enabled": true,
      "order": 1
    }
  ],
  "name": "Updated Flow Name"
}'

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

Update a flow and/or its step definitions.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

descriptionstring or nullOptional<=5000 characters

flowStepslist of objectsOptional

namestringOptional>=1 character

Response

Updated flow

createdAtstring

draftVersionIdstring

flowStepslist of objects

idstring

namestring

organizationIdstring or null

updatedAtstring

userIdstring

dashboardUrlstring

descriptionstring or null

lastRunAtstring or null

sampleMetadatamap from strings to any

stepCountinteger

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error