Skip to the content

Read a Workflow version

GET /v1/workflows/{workflow_id}/versions/{version}

Property	Value
Operation	`get_workflow_version`
Group	Workflows
Scope	`workflows:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	Not audited: A configuration read; a Workflow is not Call content.
Released in	1.59.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the workflows:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/workflows/wfl_.../versions/1" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/workflows/wfl_.../versions/1`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/workflows/wfl_.../versions/1",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`workflow_id`	path	WorkflowId	yes	The id of a Workflow: `wfl_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`version`	path	integer	yes	A version number, from 1.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	WorkflowVersion
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is WorkflowVersion.

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