Update Prompts By Label | Confident AI Docs

Updates an existing prompt version with the specified alias and version id.

aliasstringRequired

The unique alias of the prompt.

labelstringRequired

The label name of the prompt.

textstringOptional

This is the text content of the prompt. Supply this only if you are updating a text-based prompt.

messageslist of objectsOptional

This is the list of messages that make up the prompt. Supply this only if you are updating a list-based prompt.

interpolationTypeenumOptional

This is the type of interpolation format used in the prompt to insert dynamic variables.

Allowed values:

modelSettingsobjectOptional

This is the model settings for the prompt.

outputTypeenumOptional

This is the type of output expected from the prompt.

Allowed values:

outputSchemaobjectOptional

This is the output schema definition when outputType is SCHEMA.

successboolean

This is true if the prompt was successfully updated.

dataobject

deprecatedboolean

This is true if this endpoint is deprecated.

1	curl -X PUT https://api.confident-ai.com/v1/prompts/PROMPT-ALIAS/labels/PROMPT-LABEL \
2	-H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"text": "Updated hello, {{name}}!",
6	"interpolationType": "FSTRING",
7	"modelSettings": {
8	"provider": "OPEN_AI",
9	"name": "gpt-4o",
10	"temperature": 0.7
11	},
12	"outputType": "TEXT"
13	}'

1	{
2	"success": true,
3	"data": {
4	"id": "prv_xyz456",
5	"message": "Prompt version updated successfully"
6	},
7	"deprecated": false
8	}