Rest APIAPI ReferencePrompts

Create prompt

Create prompt

Request

This endpoint expects an object.
namestringRequired>=1 character
idstringOptionalformat: "uuid"
project_idstringOptionalformat: "uuid"

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

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

For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the prompt is created at workspace level.

descriptionstringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"0-255 characters
templatestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"
metadataobjectOptional
change_descriptionstringOptional
typeenumOptional
Allowed values:
template_structureenumOptionalDefaults to text

Template structure type: ‘text’ or ‘chat’. Immutable after creation.

Allowed values:
tagslist of stringsOptional

Response headers

Locationstring

Response

Created

Errors

400
Bad Request Error
409
Conflict Error
422
Unprocessable Entity Error