Skip to main content
POST
Create a flow
The config is validated exactly as the editor validates it, so an invalid graph is rejected here rather than failing later on every run. A workspace at its plan’s flow limit gets a 406.

Headers

x-apikey
string
required

API Key for authentication

Body

application/json
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}.

description
string
default:""
ui
Ui · object

Editor-only metadata. The runtime ignores it.

Response

The created 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