Workflows
List all Workflows
Get Workflow details
Create/modify Workflow
Deletes a Workflow
ModelsExpand Collapse
WorkflowsInstances
List of workflow instances
Get logs and status from instance
Create a new workflow instance
Batch create new Workflow instances
Get full step output from instance
ModelsExpand Collapse
InstanceGetResponse object { end, error, output, 11 more }
steps: array of object { attempts, config, end, 5 more } or object { end, error, finished, 3 more } or object { trigger, type } or object { end, error, finished, 5 more }
InstanceStepResponse object { error, status, event_type, output }
The event type the step is waiting on, as supplied to step.waitForEvent. Only present when type=‘waitForEvent’.
Contains the full step output or waitForEvent payload without truncation. Uses ‘[REDACTED]’ for sensitive outputs. Contains a value when status=‘complete’. May contain a ReadableStream when step.do returns one; the response serves stream outputs as application/octet-stream rather than JSON.
WorkflowsInstancesStatus
Change status of instance
WorkflowsInstancesEvents
Send event to instance
WorkflowsVersions
List deployed Workflow versions
Get Workflow version details
Get Workflow version graph
ModelsExpand Collapse
VersionGraphResponse object { id, class_name, created_on, 3 more }
graph: object { version, workflow } Versioned workflow graph payload.
Versioned workflow graph payload.
workflow: object { class_name, functions, nodes, payload } A parsed workflow entrypoint with its step graph.
A parsed workflow entrypoint with its step graph.
nodes: array of object { duration, name, type, 2 more } or object { config, name, nodes, 3 more } or object { name, options, type, 3 more } or 13 more
object { config, name, nodes, 3 more }
object { name, options, type, 3 more }
object { config, name, options, 3 more } A step.runner() call (managed CI): a shell command run in a container as one durable step.
A step.runner() call (managed CI): a shell command run in a container as one durable step.
config: object { retries, timeout } Configuration for a step (retries and timeout).
Configuration for a step (retries and timeout).
object { entrypoint, isolation_key, name, 4 more } A step.dynamic() call (managed CI): runs a workflow bundle in a dynamic Worker. The steps of the child workflow are not known statically, so nodes is empty.
A step.dynamic() call (managed CI): runs a workflow bundle in a dynamic Worker. The steps of the child workflow are not known statically, so nodes is empty.