Prompts

Create prompt version

Changed on

Create prompt version

post/v1/private/prompts/versions

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/prompts/versions
  • Auth
    none declared

Request body

namestring required
template_structure'text' | 'chat'

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.

project_idstring uuid

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

project_namestring

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

Response

OK

idstring uuid

version unique identifier, generated if absent

prompt_idstring uuid
commitstring

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

version_numberstring

sequential version number in the format v<N>; null for masks

templatestring required
metadataJsonNodeDetail
type'mustache' | 'jinja2' | 'python'
version_type'prompt_version' | 'mask'

version type discriminator; defaults to prompt_version

environmentstring

Deprecated: use 'environments' instead

environmentsstring[]
change_descriptionstring
tagsstring[]
variablesstring[]
template_structure'text' | 'chat'
created_atstring date-time
created_bystring

Changes

  • f59fc1819c0cRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status

  • 3953a50a6a0eRevision changes
    • warning

      removed the request property /

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status