DocumentationReferenceAPI ReferencePrompts

Create Prompt

View as Markdown
Create a new prompt.

Path parameters

workspacestringRequired

Request

This endpoint expects an object.
namestringRequiredformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"<=63 characters

Name of the prompt. Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen).

projectstringOptionalformat: "^[\w\-./]+$"<=255 characters
The URN of the project associated with this prompt.
descriptionstringOptional<=1000 characters
messageslist of objectsOptional
input_variableslist of stringsOptional
toolslist of objectsOptional
tool_choicestring or map from strings to anyOptional
response_formatmap from strings to anyOptional
inference_paramsobjectOptional
Parameters for model inference. Extra fields can be supplied for additional options applied to the inference request directly. Fields not supported by the model may cause inference errors during evaluation.
tagslist of stringsOptional

Response

Create a new prompt
namestringformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"<=63 characters

Name of the entity. Name/workspace combo must be unique across all entities. Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen).

workspacestringformat: "^[\w\-.]+$"<=255 characters

The workspace of the entity. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

created_atdatetime
The timestamp of model entity creation
updated_atdatetime
The timestamp of the last model entity update
idstringOptional
Unique identifier for the prompt.
projectstringOptionalformat: "^[\w\-./]+$"<=255 characters
The URN of the project associated with this entity.
descriptionstringOptional<=1000 characters
Optional description of the prompt.
messageslist of objectsOptional
Ordered list of chat messages that make up the prompt.
input_variableslist of stringsOptional
Names of the Jinja2 template variables the prompt expects.
toolslist of objectsOptional

Optional OpenAI-compatible tool definitions to send with the prompt.

tool_choicestring or map from strings to anyOptional

Controls which (if any) tool is called: ‘none’, ‘auto’, ‘required’, or a named-tool object.

response_formatmap from strings to anyOptional

Optional OpenAI-compatible response_format, e.g. a json_schema structured-output spec.

inference_paramsobjectOptional

Optional default model and sampling parameters (temperature, top_p, max_tokens, …).

tagslist of stringsOptional

Optional free-form tags for organizing prompts.

Errors

422
Unprocessable Entity Error