Get prompt by id

GET

/v1/private/prompts/:id

GET

/api/v1/private/prompts/:id

$ curl http://localhost:5173/api/v1/private/prompts/id

1 {
2   "name": "string",
3   "id": "string",
4   "project_id": "string",
5   "description": "string",
6   "template_structure": "text",
7   "tags": [
8     "string"
9   ],
10   "created_at": "2024-01-15T09:30:00Z",
11   "created_by": "string",
12   "last_updated_at": "2024-01-15T09:30:00Z",
13   "last_updated_by": "string",
14   "version_count": 1,
15   "latest_version": {
16     "template": "string",
17     "id": "string",
18     "prompt_id": "string",
19     "commit": "string",
20     "version_number": "string",
21     "metadata": {},
22     "type": "mustache",
23     "version_type": "prompt_version",
24     "environments": [
25       "string"
26     ],
27     "change_description": "string",
28     "tags": [
29       "string"
30     ],
31     "variables": [
32       "string"
33     ],
34     "template_structure": "text",
35     "created_at": "2024-01-15T09:30:00Z",
36     "created_by": "string",
37     "environment": "string"
38   },
39   "requested_version": {
40     "template": "string",
41     "id": "string",
42     "prompt_id": "string",
43     "commit": "string",
44     "version_number": "string",
45     "metadata": {},
46     "type": "mustache",
47     "version_type": "prompt_version",
48     "environments": [
49       "string"
50     ],
51     "change_description": "string",
52     "tags": [
53       "string"
54     ],
55     "variables": [
56       "string"
57     ],
58     "template_structure": "text",
59     "created_at": "2024-01-15T09:30:00Z",
60     "created_by": "string",
61     "environment": "string"
62   }
63 }

Get prompt by id; when mask_id or environment is provided, requestedVersion is populated with the resolved version. mask_id and environment are mutually exclusive.

Path parameters

idstringRequiredformat: "uuid"

Query parameters

mask_idstringOptionalformat: "uuid"

Optional mask version id; when set, requestedVersion is the mask row for that id

environmentstringOptionalformat: "^[A-Za-z0-9_-]+$"0-150 characters

Optional environment name; when set, requestedVersion is the version mapped to that environment for the prompt

Response

Prompt resource

namestring>=1 character

idstringOptionalformat: "uuid"

project_idstringOptionalformat: "uuid"

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

descriptionstringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"0-255 characters

template_structureenumOptionalDefaults to text

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

tagslist of stringsOptional

created_atdatetimeOptionalRead-only

created_bystringOptionalRead-only

last_updated_atdatetimeOptionalRead-only

last_updated_bystringOptionalRead-only

version_countlongOptionalRead-only

latest_versionobjectOptional

requested_versionobjectOptional

Errors

400

Bad Request Error

404

Not Found Error