Update Prompt

PUT

https://host.com/apis/models/v2/workspaces/:workspace/prompts/:name

PUT

/apis/models/v2/workspaces/:workspace/prompts/:name

$ curl -X PUT https://host.com/apis/models/v2/workspaces/workspace/prompts/name \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "name": "llama-3.1-8b",
3   "workspace": "research-team-alpha",
4   "created_at": "2024-01-15T09:30:00Z",
5   "updated_at": "2024-04-20T14:45:00Z",
6   "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
7   "project": "nlp-models/llama",
8   "description": "A prompt designed for the LLaMA 3.1 8B model to assist with natural language understanding tasks.",
9   "messages": [
10     {
11       "role": "system",
12       "content": "You are a helpful assistant specialized in summarizing technical documents."
13     }
14   ],
15   "input_variables": [
16     "document_text"
17   ],
18   "tools": [
19     {
20       "type": "function",
21       "function": {
22         "name": "summarize_text",
23         "description": "Generates a concise summary of the provided text input.",
24         "parameters": {},
25         "strict": true
26       }
27     }
28   ],
29   "tool_choice": "auto",
30   "response_format": {},
31   "inference_params": {
32     "model": "llama-3.1-8b",
33     "temperature": 0.7,
34     "max_tokens": 512,
35     "max_completion_tokens": 256,
36     "top_p": 0.9,
37     "stop": [
38       "\n\n"
39     ]
40   },
41   "tags": [
42     "llama",
43     "summarization",
44     "v3.1"
45   ]
46 }

Update an existing prompt (full replacement of mutable fields).

Path parameters

workspacestringRequired

namestringRequired

Request

This endpoint expects an object.

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

Update an existing prompt

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

Name of the entity. Name/workspace combo must be unique across all entities. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

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

idstring

Unique identifier for the prompt.

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

The URN of the project associated with this entity.

descriptionstring<=1000 characters

Optional description of the prompt.

messageslist of objects

Ordered list of chat messages that make up the prompt.

input_variableslist of strings

Names of the Jinja2 template variables the prompt expects.

toolslist of objects

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

tool_choicestring or map from strings to any

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

response_formatmap from strings to any

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

inference_paramsobject

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

tagslist of strings

Optional free-form tags for organizing prompts.

Errors

422

Unprocessable Entity Error