Get Prompt

GET

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

GET

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

$ curl /apis/models/v2/workspaces/workspace/prompts/name \
>      -H "Content-Type: application/json"

1 {
2   "name": "llama-3.1-8b",
3   "workspace": "research_team_alpha",
4   "created_at": "2024-01-15T09:30:00Z",
5   "updated_at": "2024-01-15T09:30:00Z",
6   "id": "a3f47c2e-9b1d-4f3a-8c2e-1d2b3f4a5c6d",
7   "project": "urn:project:ai-models/llama",
8   "description": "Prompt for generating responses using the LLaMA 3.1 8B model.",
9   "messages": [
10     {
11       "role": "system",
12       "content": "You are a helpful assistant specialized in AI model explanations."
13     }
14   ],
15   "input_variables": [
16     "query"
17   ],
18   "tools": [
19     {
20       "type": "function",
21       "function": {
22         "name": "get_model_info",
23         "description": "Fetches detailed information about the specified AI model.",
24         "parameters": {
25           "type": "object",
26           "properties": {
27             "model_name": {
28               "type": "string",
29               "description": "The name of the model to retrieve information for."
30             }
31           },
32           "required": [
33             "model_name"
34           ]
35         },
36         "strict": true
37       }
38     }
39   ],
40   "tool_choice": "auto",
41   "response_format": {
42     "type": "json_schema",
43     "schema": {
44       "type": "object",
45       "properties": {
46         "answer": {
47           "type": "string",
48           "description": "The generated answer to the user's query."
49         }
50       },
51       "required": [
52         "answer"
53       ]
54     }
55   },
56   "inference_params": {
57     "model": "llama-3.1-8b",
58     "temperature": 0.7,
59     "max_tokens": 256,
60     "max_completion_tokens": 256,
61     "top_p": 0.9,
62     "stop": [
63       "\n"
64     ]
65   },
66   "tags": [
67     "llama",
68     "chat",
69     "ai-assistant"
70   ]
71 }

Get a prompt by workspace and name.

Path parameters

workspacestringRequired

namestringRequired

Response

Return prompt details

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

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