Rest APIAPI ReferencePrompts

Create prompt version

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.

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

OK
templatestring>=1 character
idstringOptionalformat: "uuid"
version unique identifier, generated if absent
prompt_idstringOptionalRead-onlyformat: "uuid"
commitstringOptionalformat: "^[a-zA-Z0-9]{8}$"
version short unique identifier, generated if absent. it must be 8 characters long
version_numberstringOptionalRead-only

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

metadataobjectOptional
typeenumOptional
version_typeenumOptional

version type discriminator; defaults to prompt_version

environmentslist of stringsOptional
change_descriptionstringOptional
tagslist of stringsOptional
variableslist of stringsOptionalRead-only
template_structureenumOptionalRead-only
created_atdatetimeOptionalRead-only
created_bystringOptionalRead-only
environmentstringOptionalformat: "^[A-Za-z0-9_-]+$"0-150 charactersDeprecated

Deprecated: use ‘environments’ instead

Errors

400
Bad Request Error
409
Conflict Error
422
Unprocessable Entity Error