Create prompt version | Opik Documentation

curl -X POST http://localhost:5173/api/v1/private/prompts/versions \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Customer Support Response",
  "version": {
    "template": "Hello {{customer_name}}, thank you for reaching out. We have received your request regarding {{issue_topic}} and will get back to you shortly."
  }
}'

{
  "template": "Hello {{customer_name}}, thank you for reaching out. We have received your request regarding {{issue_topic}} and will get back to you shortly.",
  "id": "d4f5e6a7-b8c9-4d0e-9f12-3456789abcde",
  "prompt_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "commit": "1a2b3c4d",
  "metadata": {},
  "type": "mustache",
  "change_description": "Initial version of customer support response template",
  "tags": [
    "support",
    "customer-service"
  ],
  "variables": [
    "customer_name",
    "issue_topic"
  ],
  "template_structure": "text",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "jane.doe@example.com"
}

Create prompt version

Request

This endpoint expects an object.

namestringRequired>=1 character

versionobjectRequired

template_structureenumOptionalDefaults to text

Template structure for the prompt: ‘text’ or ‘chat’. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt’s template structure is used. Template structure is immutable after prompt creation.

Allowed values:

exclude_blueprint_update_for_projectslist of stringsOptional

Optional set of project IDs to exclude from automatic blueprint creation when this prompt version is committed.

project_idstringOptionalformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

If provided, scopes the prompt to the specified project. Ignored when project_id is provided.

Response

templatestring>=1 character

idstringformat: "uuid"

version unique identifier, generated if absent

prompt_idstringRead-onlyformat: "uuid"

commitstringformat: "^[a-zA-Z0-9]{8}$"

version short unique identifier, generated if absent. it must be 8 characters long

metadataobject

typeenum

Allowed values:

change_descriptionstring

tagslist of strings

variableslist of stringsRead-only

template_structureenumRead-only

Allowed values:

created_atdatetimeRead-only

created_bystringRead-only

Errors

400

Bad Request Error

409

Conflict Error

422

Unprocessable Entity Error