Skip to main content
PATCH
Update flow fields
Only the fields you send change. A rename needs neither a config nor a token; internal_version is required alongside config. A body carrying nothing but internal_version is a 400 — it would rotate the token without changing anything.

Headers

x-apikey
string
required

API Key for authentication

Path Parameters

flow_id
string
required

Flow identifier, e.g. fl_ab12cd34

Body

application/json

Only the fields you send change. internal_version is required alongside config.

name
string | null
description
string | null
config
Config · object | null
ui
Ui · object | null
internal_version
string | null

Response

The updated flow

A flow plus the pieces needed to edit it. config is the graph, ui is editor-only metadata the runtime ignores, and internal_version is the concurrency token you send back on a write.

id
string
required
name
string
required
description
string
required
inputs
FlowInput · object[]
required
outputs
FlowOutput · object[]
required
config
Config · object
required

The flow definition: inputs, nodes, output.

ui
Ui · object
required

Editor-only metadata. The runtime never reads it.

internal_version
string
required

Concurrency token. Send it back on PUT (required) and on PATCH when changing config.

created_at
string
required
updated_at
string
required