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
| Field | Type | Required | Description |
|---|---|---|---|
active_version | integer or null | yes | The 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_terms | array of PromptAllowTerm | yes | Staff and place names that phi_literal does not report (1.55.0), at most 100 of at most 100 characters. |
archived_at | Timestamp or null | yes | When 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. |
constants | PromptConstants | yes | |
created_at | Timestamp | yes | |
declarations | PromptDeclarations | yes | |
default_layer | boolean | yes | True 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. |
description | string or null | yes | For reviewers; never sent to the model. |
forked_from | PromptForkedFrom or null | yes | |
id | PromptTemplateId | yes | |
include_organization_layer | boolean | yes | For 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_version | integer or null | yes | The highest published version, or null before the first publish. |
layer | PromptLayer | yes | |
lint | array of PromptLintFinding | yes | The 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. |
name | PromptTemplateName | yes | |
object | "prompt_template" | yes | |
organization_id | OrganizationId | yes | |
purpose | PromptPurpose | yes | |
revision | integer | yes | Counts writes to the draft; returned as the ETag and required in If-Match. |
updated_at | Timestamp | yes | |
variants | PromptVariants | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.