Skip to main content
A workflow runs steps top to bottom. Each step runs one of your agents or saved connections, or reshapes data, and If, For each, Approval and parallel blocks hold more steps. Use the /v1/workflows/ endpoints to create a workflow, save new versions, run it and read each run’s step results.

Workflow ids

Use /v1/workflows/ for workflows. A workflow’s id is the same id you already use with the agent endpoints, so an existing workflow works there with no change. Calls to the agent endpoints with a workflow’s id keep working too.

Definitions

You create a workflow, and save each new version, from a complete definition: its inputs, its steps and, optionally, the step whose output a run returns. A definition that fails its checks returns each problem with the step it belongs to. The Workflow Builder skill has a full example. A version saved in the old graph format still runs, but comes back read-only: its definition is null, and conversion_reasons says why it couldn’t be converted. Saving a new version replaces it.

Runs

Starting a run returns it at once, or with wait, when it finishes or after 60 seconds, whichever is first. A run’s detail lists what each step received and returned.