Skip to main content
PUT
Replace a flow
internal_version is required and must be the value the last Get a workspace flow returned. A stale token is refused with 409 rather than overwriting someone else’s edit.
To change one node without resending the whole graph, use Apply targeted edits instead.

Headers

x-apikey
string
required

API Key for authentication

Path Parameters

flow_id
string
required

Flow identifier, e.g. fl_ab12cd34

Body

application/json

Whole-flow replace. internal_version must be the value the last GET /v1/flows/{flow_id} returned.

name
string
required

Display name of the flow.

config
Config · object
required

Flow definition: {inputs: [...], nodes: [...], output: {...}}. Copy the shape of an existing flow from GET /v1/flows/{flow_id}.

internal_version
string
required
description
string
default:""
ui
Ui · object

Editor-only metadata. The runtime ignores it.

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