VocalDocscontracts 1.65.0

PromptTemplate

A Prompt template (1.55.0, ADR 0043): the draft of a layer of instructions in the closed template language, with its declarations, its lint findings and the version Agents and dispatch resolve.

An object with 21 fields.

Fields

FieldTypeRequiredDescription
active_versioninteger or nullyesThe version an Agent publish pins when its prompt names none (Agent layer), or the version dispatch resolves for the Agents that receive this layer (Organization layer); null when none is active.
allow_termsarray of PromptAllowTermyesStaff and place names that phi_literal does not report (1.55.0), at most 100 of at most 100 characters.
archived_atTimestamp or nullyesWhen DELETE archived the template, or null. An archived template takes no write, publish or activation (409 prompt_template_archived); its versions keep serving the Agent versions that pin them.
constantsPromptConstantsyes
created_atTimestampyes
declarationsPromptDeclarationsyes
default_layerbooleanyesTrue for the default Organization layer, the one an Agent that names no organization_layer receives (1.55.0). Only an Organization layer may set it (prompt_layer_field_not_allowed); setting it clears it on the other layers. Read at dispatch, never part of a version.
descriptionstring or nullyesFor reviewers; never sent to the model.
forked_fromPromptForkedFrom or nullyes
idPromptTemplateIdyes
include_organization_layerbooleanyesFor a task template: also compose the Organization layer (prompt-manager.md section 4). Only a task template may set it (prompt_layer_field_not_allowed).
latest_versioninteger or nullyesThe highest published version, or null before the first publish.
layerPromptLayeryes
lintarray of PromptLintFindingyesThe lint findings of the draft at its last save (1.55.0): errors and warnings. A save is never refused for a finding; a publish refuses the errors and the unacknowledged warnings. Agent publish adds the checks that need the Agent.
namePromptTemplateNameyes
object"prompt_template"yes
organization_idOrganizationIdyes
purposePromptPurposeyes
revisionintegeryesCounts writes to the draft; returned as the ETag and required in If-Match.
updated_atTimestampyes
variantsPromptVariantsyes

Used by

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