Push Prompts | Confident AI Docs

Creates a new prompt on your Confident AI project.

aliasstringRequired

The unique alias of the prompt.

textstringOptional

The text content of the prompt. Supply this only if you are creating a text-based prompt.

messageslist of objectsOptional

The list of messages that make up the prompt. Supply this only if you are creating a list-based prompt.

interpolationTypeenumOptionalDefaults to FSTRING

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

Allowed values:

modelSettingsobjectOptional

This is the model settings for the prompt.

outputTypeenumOptionalDefaults to TEXT

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 created.

dataobject

This maps to the prompt version id.

linkstring

This is the URL to redirect to after the prompt is created.

deprecatedboolean

This is true if this endpoint is deprecated.

1	import requests
2
3	url = "https://api.confident-ai.com/v1/prompts"
4
5	payload = {
6	"alias": "Prompt Name",
7	"text": "Hello, {{name}}!",
8	"interpolationType": "FSTRING",
9	"outputType": "TEXT"
10	}
11	headers = {
12	"CONFIDENT_API_KEY": "<PROJECT-API-KEY>",
13	"Content-Type": "application/json"
14	}
15
16	response = requests.post(url, json=payload, headers=headers)
17
18	print(response.json())

1	{
2	"success": true,
3	"data": {
4	"id": "prm_xyz456"
5	},
6	"link": "https://app.confident-ai.com/project/<PROJECT_ID>/prompt-studio/editor/prm_xyz456",
7	"deprecated": false
8	}