VocalDocscontracts 1.65.0

AgentVersion

An immutable snapshot of an Agent; every Call pins the version it runs.

An object with 20 fields.

Fields

FieldTypeRequiredDescription
activebooleanyesTrue when new Calls run this version.
agent_idAgentIdyes
analyzer_versionsarray of PinnedAnalyzerBindingnoThe analyzer bindings the version froze at publish (1.56.0, FR-calls-19), in the draft's order, each with the analyzer version pinned and every field explicit; finalize schedules the version's analyses from them. Absent from an api older than 1.56.0, and absent or empty for a version that binds none; a reader treats its absence as none.
configAgentConfigyes
config_sha256stringyesThe SHA-256 of the canonical configuration, in lowercase hex.
engineEngineKindyes
knowledge_bindingsarray of PinnedKnowledgeBindingnoThe Knowledge bindings the version froze at publish (1.53.0, FR-knowledge-2), in the draft's order, each with every field explicit and, for a pinned binding, the version active at publish. Absent from an api older than 1.53.0, and absent or empty for a version with no binding; a reader treats its absence as none.
object"agent_version"yes
policy_versionsarray of PinnedPolicynoThe Policy versions the version pins (1.47.0, FR-agents-7): the active version of each Policy the draft's policy_ids attached, at publish, so that a later Policy change reaches Calls only through a new Agent version. Organization-scoped Policies are not pinned here: dispatch resolves them for each Call. Absent from an api older than 1.47.0; a reader treats its absence as none.
promptPinnedPromptnoThe prompt the version froze at publish (1.55.0, FR-prompts-1): the template version it pins, the platform base it tracks or pinned, the Organization layer it names and the acknowledged warnings. Absent for a version whose Agent layer is its inline instructions, which tracks the current base and receives the default Organization layer, and from an api older than 1.55.0.
published_atTimestampyes
published_byActorRefyes
source_revisionintegeryesThe draft revision this version was published from.
squad_versionsarray of PinnedSquadMembernoThe squad Agent versions the version pinned at publish (1.58.0, FR-agents-14), in the draft's order: each squad Agent's active version then, so that a later publish of a squad Agent reaches Calls only through a new root version. Absent from an api older than 1.58.0, and absent or empty for a version without a Squad; a reader treats its absence as none.
statusAgentVersionStatusyes
tool_bindingsarray of FrozenToolBindingnoThe Tool bindings the version froze at publish (1.60.0): every binding of the Agent then, in creation order. Absent from an api older than 1.60.0, and absent or empty for a version with none; a reader treats its absence as none.
toolsarray of PinnedToolnoThe Tools the version froze at publish (1.49.0, FR-agents-7): a copy of the definition of each Tool the draft's tool_ids attached, at its revision then, without any secret, in the draft's order, so that a later edit of a Tool reaches Calls only through a new Agent version. Absent from an api older than 1.49.0, and absent or empty for a version with no Tools; a reader treats its absence as none.
versionintegeryesThe snapshot number, from 1.
warningsarray of ErrorDetailnoThe warnings the publish found and did not refuse (1.59.0): the statechart warnings of StatechartWarningCode (slot_trust_warning, squad_setting_ignored, proposal_reaches_transfer), each with its pointer, computed over the Tools of the root Agent and of each squad Agent. Empty when none; absent from an api before 1.59.0, which a reader treats as none.
workflow_versionPinnedWorkflownoThe Workflow version the Agent version pinned at publish (1.59.0): the active version of the Workflow its draft names then. Absent for a version that names none and from an api older than 1.59.0; a reader treats its absence as none.

Used by

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