VocalDocscontracts 1.65.0

WorkflowCreateRequest

Creates a Workflow draft at revision 1 (1.59.0): a definition (WorkflowInput) and its description. A process-scope Workflow, and what the release does not build, are refused with capability_not_available; every issue of section 5.3 with validation_failed.

An object with 13 fields.

Fields

FieldTypeRequiredDescription
agent_idAgentIdnoConversation scope only, and required there: the default Agent, which supplies voice, transcriber, model, Policies, Tools and destinations.
correlationWorkflowCorrelationInputno
descriptionstringnoFor reviewers; never spoken or sent to a model.
entryWorkflowNodeIdyes
inputsmap of WorkflowFieldInputnoCall variables (conversation) or start inputs (process).
limitsWorkflowLimitsInputyes
namestringyesKebab-case, unique per Organization.
nodesarray of WorkflowNodeInputyesExactly one entry node; at most 200 nodes, loop bodies included (target).
outputsmap of WorkflowFieldInputnoThe typed result returned to a parent or a starting Process.
scopeWorkflowScopeyes
settingsmap of WorkflowSettingnoProcess scope: named thresholds and constants that evaluate nodes read.
slotsmap of WorkflowFieldInputnoConversation scope: the Session's typed slots.
varsmap of WorkflowFieldInputnoProcess scope: the instance's working data.

Used by

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