v36

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0187270483.0 KB
Workflows

Create a Workflow

Create a workflow.

A workflow is a directed acyclic graph of nodes (each pointing at a function) with one entry point (mainNodeName). The graph runs end-to-end on every call.

Required structure

  • name: unique within the environment, alphanumeric plus hyphens and underscores.
  • mainNodeName: must match one of the nodes[].name values, and must not be the destination of any edge.
  • nodes: at least one. Each node has a unique name and a function reference (by functionName or functionID, optionally pinned to a versionNum).
  • edges: optional for single-node workflows. For branching sources (Classify, semantic Split), each edge carries a destinationName matching a classifications[].name or itemClasses[].name on the source function.

The created workflow is at versionNum: 1. Subsequent PATCH /v3/workflows/{workflowName} calls produce new versions.

Common patterns

  • Single-node: one extract/classify function, no edges.
  • Sequential: extract → enrich → payload_shaping (linear edges).
  • Branching: classify → multiple extracts (one edge per classification name).
  • Split-then-process: split → multiple extracts (one edge per item class).

See Workflows explained for end-to-end examples of each pattern.

post/v3/workflows

Request body

namestring required

Unique name for the workflow. Must match ^[a-zA-Z0-9_-]{1,128}$.

displayNamestring

Human-readable display name.

tagsstring[]

Tags to categorize and organize the workflow.

mainNodeNamestring required

Name of the entry-point node. Must not be a destination of any edge.

Response

The request has succeeded.

errorstring

Error message if the workflow creation failed.