Sign in
prompts

Update a prompt version

Update a prompt version. Set deploy: true to make this version live immediately.

patch/api/prompts/{prompt_id}/versions/{version}/

Path parameters

prompt_idstring required

The unique prompt identifier.

versioninteger required

The prompt version number.

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Request body

descriptionstring

Version description.

messagesobject[]

Messages for this version. Use {{variable_name}} placeholders for template variables.

thinkingApiPromptsPromptIdVersionsVersionPatchRequestBodyContentApplicationJsonSchemaThinking

Optional provider-specific reasoning configuration.

modelstring

Primary model for this version.

streamboolean

Whether to stream responses.

temperaturenumber double

Sampling temperature (0-2).

max_tokensinteger

Maximum tokens to generate.

top_pnumber double

Nucleus sampling parameter.

frequency_penaltynumber double

Frequency penalty (-2 to 2).

presence_penaltynumber double

Presence penalty (-2 to 2).

reasoning_effortstring nullable
verbositystring nullable
seedinteger nullable
variablesApiPromptsPromptIdVersionsVersionPatchRequestBodyContentApplicationJsonSchemaVariables

Template variables and their default values.

fallback_modelsstring[]

Fallback models if the primary model fails.

load_balance_modelsApiPromptsPromptIdVersionsVersionPatchRequestBodyContentApplicationJsonSchemaLoadBalanceModelsItems[]

Weighted load-balancing model configuration.

toolsApiPromptsPromptIdVersionsVersionPatchRequestBodyContentApplicationJsonSchemaToolsItems[]

Tools available to the model.

response_formatApiPromptsPromptIdVersionsVersionPatchRequestBodyContentApplicationJsonSchemaResponseFormat

Structured output / response format configuration.

json_schemaApiPromptsPromptIdVersionsVersionPatchRequestBodyContentApplicationJsonSchemaJsonSchema

JSON schema used for structured outputs when configured.

is_enforcing_response_formatboolean

Whether to strictly enforce the response format.

deployboolean

Deploy this version as the live version immediately.

Response

Prompt version updated successfully.

idstring
prompt_version_idstring
versioninteger
descriptionstring nullable
messagesobject[]
thinkingApiPromptsPromptIdVersionsVersionPatchResponsesContentApplicationJsonSchemaThinking
modelstring
streamboolean
temperaturenumber double nullable
max_tokensinteger nullable
top_pnumber double nullable
frequency_penaltynumber double nullable
presence_penaltynumber double nullable
reasoning_effortstring nullable
verbositystring nullable
seedinteger nullable
variablesApiPromptsPromptIdVersionsVersionPatchResponsesContentApplicationJsonSchemaVariables
fallback_modelsstring[] nullable
load_balance_modelsApiPromptsPromptIdVersionsVersionPatchResponsesContentApplicationJsonSchemaLoadBalanceModelsItems[] nullable
toolsApiPromptsPromptIdVersionsVersionPatchResponsesContentApplicationJsonSchemaToolsItems[] nullable
response_formatApiPromptsPromptIdVersionsVersionPatchResponsesContentApplicationJsonSchemaResponseFormat
json_schemaApiPromptsPromptIdVersionsVersionPatchResponsesContentApplicationJsonSchemaJsonSchema
is_enforcing_response_formatboolean
readonlyboolean
is_deployedboolean
created_atstring date-time
updated_atstring date-time

Changes