VocalDocscontracts 1.65.0

PromptTemplateRenderRequest

A dry run of one Prompt template with synthetic inputs (1.55.0). A body that does not parse is 422 validation_failed with template_invalid; a version the template lacks is 404 not_found.

An object with 9 fields.

Fields

FieldTypeRequiredDescription
callPromptRenderCallInputno
constantsmap of PromptConstantValuenoOrganization constants for this render; those of the Organization layer the render resolves when omitted. display_name is the Organization name.
retrievalmap of booleannoWhether each Knowledge binding returned passages for this request, by handle: true renders the first branch of its retrieval slot, false or absent the second.
slotsmap of PromptSlotValuenoSynthetic slot values; an unset slot renders empty or its default().
statestringnoThe active state, the state root.
time_nowRequestTimestampnoThe time.now root; the request instant when omitted.
variablesmap of VariableValuenoSynthetic values of the declared variables. A value of an undeclared name is variable_unknown, of the wrong type variable_type; an optional variable without a value renders empty and is named in missing_values.
variantPromptVariantKeynoThe variant to render; default when omitted, and default for a key the template lacks.
versionintegernoThe version to render; the draft when omitted.

Used by

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