VocalDocscontracts 1.65.0

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

FieldTypeRequiredDescription
activebooleanyesTrue for the active version: the one the next Agent version publish pins.
agent_idAgentIdnoConversation scope only, and required there: the default Agent, which supplies voice, transcriber, model, Policies, Tools and destinations.
correlationWorkflowCorrelationno
descriptionstring or nullyes
engine_versionstringyesThe Zen engine version the version's decisions and expressions were checked under.
entryWorkflowNodeIdyes
format_versionintegeryesThe version of the compiled form the Session runs, 1 in this release.
graph_sha256stringyesThe SHA-256 of the canonical JSON (RFC 8785) of the definition as published, in lowercase hex.
inputsmap of WorkflowFieldnoCall variables (conversation) or start inputs (process).
limitsWorkflowLimitsyes
namestringyesKebab-case, unique per Organization.
nodesarray of WorkflowNodeyesExactly one entry node; at most 200 nodes, loop bodies included (target).
notesstring or nullyes
object"workflow_version"yes
outputsmap of WorkflowFieldnoThe typed result returned to a parent or a starting Process.
pinsWorkflowPinsyes
published_atTimestampyes
published_byActorRefyes
scopeWorkflowScopeyes
settingsmap of WorkflowSettingnoProcess scope: named thresholds and constants that evaluate nodes read.
slotsmap of WorkflowFieldnoConversation scope: the Session's typed slots.
source_revisionintegeryesThe draft revision this version was published from.
statusWorkflowVersionStatusyes
varsmap of WorkflowFieldnoProcess scope: the instance's working data.
versionintegeryesThe snapshot number, from 1.
workflow_idWorkflowIdyes

Used by

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