v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01144108427.9 KB
Workflow

Execute Workflow (v2 sync or stream)

post/api/v2/workflows

Request body

dataobject nullable

Optional live-canvas override of the flow's nodes/edges; takes priority over the saved flow data.

filesstring[] nullable

Optional list of pre-uploaded file paths to attach to the run.

flow_idstring required

UUID of the flow to run.

globalsobject

Request-level global variables made available to workflow components. Keys may use any printable string up to 256 chars; values are capped at 65536 chars. Body globals always win over the legacy X-LANGFLOW-GLOBAL-VAR-* headers. Honored in sync mode; ignored for stream/background modes.

idempotency_keystring nullable

Optional client-supplied key that dedupes background submits. Two background runs with the same key return the same job_id instead of queuing duplicate work. Ignored for sync/stream modes.

input_valuestring

Chat-style input value.

mode'sync' | 'stream' | 'background'

Execution mode for a v2 workflow run.

output_idsstring[] nullable

Component ids of the outputs you want as the answer (sync mode). When set, output.text resolves among only these, so naming one text output makes output.reason deterministic on multi-output flows. The full outputs map is still returned. Ids must be outputs of this flow or the request is rejected before the flow runs. Ignored for stream/background modes.

session_idstring nullable

When set, message memory and chat history scope to this session.

start_component_idstring nullable

Partial-run start component id.

stop_component_idstring nullable

Partial-run stop component id.

stream_protocolstring

Wire protocol for streaming events. Defaults to langflow (raw EventManager payloads). agui emits AG-UI events. Unknown values return 422 with the available list. Ignored when mode=sync.

tweaksobject

Per-component parameter overrides keyed by component id.

Example request

{
  "flow_id": "67ccd2be-17f0-8190-81ff-3bb2cf6508e6",
  "input_value": "Hello, how can you help me today?"
}

Response

Workflow execution response

OR