WorkflowVersion
An immutable snapshot of a Workflow (1.59.0): its definition as published, the digest and format of what the Session runs, the engine version and the pins. An Agent version pins the version it runs, and every Call records it.
An object with 26 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
active | boolean | yes | True for the active version: the one the next Agent version publish pins. |
agent_id | AgentId | no | Conversation scope only, and required there: the default Agent, which supplies voice, transcriber, model, Policies, Tools and destinations. |
correlation | WorkflowCorrelation | no | |
description | string or null | yes | |
engine_version | string | yes | The Zen engine version the version's decisions and expressions were checked under. |
entry | WorkflowNodeId | yes | |
format_version | integer | yes | The version of the compiled form the Session runs, 1 in this release. |
graph_sha256 | string | yes | The SHA-256 of the canonical JSON (RFC 8785) of the definition as published, in lowercase hex. |
inputs | map of WorkflowField | no | Call variables (conversation) or start inputs (process). |
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). |
notes | string or null | yes | |
object | "workflow_version" | yes | |
outputs | map of WorkflowField | no | The typed result returned to a parent or a starting Process. |
pins | WorkflowPins | yes | |
published_at | Timestamp | yes | |
published_by | ActorRef | yes | |
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. |
source_revision | integer | yes | The draft revision this version was published from. |
status | WorkflowVersionStatus | yes | |
vars | map of WorkflowField | no | Process scope: the instance's working data. |
version | integer | yes | The snapshot number, from 1. |
workflow_id | WorkflowId | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.