Patch Prompt Template Version

patch/rest/prompt-templates/{identifier}

Request

Base URL
https://docs.promptlayer.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/promptlayer/apis/promptlayer-api/docs/rest/prompt-templates/:identifier/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

identifierstring required

The prompt template name or ID.

Request body

versioninteger nullable

The base version number to patch from. Mutually exclusive with label. If neither is provided, the latest version is used.

labelstring nullable

The release label identifying the base version to patch from (e.g. 'prod', 'staging'). Mutually exclusive with version.

model_parametersobject nullable

Parameters to shallow-merge into existing model parameters. Existing keys not provided are preserved.

response_formatobject nullable

Convenience field to set response_format in model parameters. Cannot be used simultaneously with response_format inside model_parameters. Set to null to remove.

commit_messagestring nullable

A message describing the changes in this version.

release_labelsstring[] nullable

Release labels to create or move to the newly created version.

Response

New version created successfully

idinteger required

The ID of the prompt template.

prompt_namestring required

The name of the prompt template.

prompt_version_idinteger required

The ID of the created prompt version.

version_numberinteger required

The version number of the prompt template.

tagsstring[] required