Skip to main content
Once you’ve built and saved a workflow (see Building Workflows), you execute it and read its results either from the definition object or through client.runs. This page covers both.

Running a workflow

Two ways to execute: 1. From the definition object → a Run you poll or stream
2. Synchronous one-shot via the runs service
body/input is a dict keyed by the workflow’s input labels.
For input formats (node labels, node IDs, files), streaming, and webhook callbacks, see Running Workflows.

The runs service

The Run object

Fields: id, status, progress, progress_details, workflow_id, input, output, created_at, finished_at.
Methods (each with an a-prefixed async twin):
wait(output_only=True) returns just the output dict; otherwise it returns the refreshed Run. Streaming yields RunEvents as the run progresses.