Workflow

A Workflow (1.59.0, ADR 0039): the editable draft of one graph definition with its scope. Calls run published Workflow versions, which an Agent version pins, never the draft.

An object with 22 fields.

Fields

Field	Type	Required	Description
`active_version`	integer or null	yes	The version the next Agent version publish pins, or null when none is active.
`agent_id`	AgentId	no	Conversation scope only, and required there: the default Agent, which supplies voice, transcriber, model, Policies, Tools and destinations.
`archived_at`	Timestamp or null	yes	When `DELETE` archived the Workflow, or null. An archived Workflow takes no write, publish or activation (409 `workflow_archived`); its pinned versions keep running.
`correlation`	WorkflowCorrelation	no
`created_at`	Timestamp	yes
`description`	string or null	yes	For reviewers; never spoken or sent to a model.
`entry`	WorkflowNodeId	yes
`id`	WorkflowId	yes
`inputs`	map of WorkflowField	no	Call variables (conversation) or start inputs (process).
`latest_version`	integer or null	yes	The highest published version, or null before the first publish.
`limits`	WorkflowLimits	yes
`name`	string	yes	Kebab-case, unique per Organization.
`nodes`	array of WorkflowNode	yes	Exactly one entry node; at most 200 nodes, loop bodies included (target).
`object`	`"workflow"`	yes
`organization_id`	OrganizationId	yes
`outputs`	map of WorkflowField	no	The typed result returned to a parent or a starting Process.
`revision`	integer	yes	Counts writes to the draft; returned as the ETag and required in If-Match.
`scope`	WorkflowScope	yes
`settings`	map of WorkflowSetting	no	Process scope: named thresholds and constants that `evaluate` nodes read.
`slots`	map of WorkflowField	no	Conversation scope: the Session's typed slots.
`updated_at`	Timestamp	yes
`vars`	map of WorkflowField	no	Process scope: the instance's working data.

Used by

The operations whose parameters, request body or responses name this shape directly.