Get prompts by project

GET

/v1/private/projects/:projectId/prompts

GET

/api/v1/private/projects/:projectId/prompts

1 import requests
2 
3 url = "http://localhost:5173/api/v1/private/projects/projectId/prompts"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.get(url, json=payload, headers=headers)
9 
10 print(response.json())

200Retrieved

1 {
2   "page": 1,
3   "size": 1,
4   "total": 1,
5   "content": [
6     {
7       "name": "Image Captioning Prompt",
8       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9       "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
10       "description": "Generate descriptive captions for images in the dataset.",
11       "template_structure": "text",
12       "tags": [
13         "image",
14         "caption",
15         "nlp"
16       ],
17       "created_at": "2024-01-15T09:30:00Z",
18       "created_by": "alice.jones",
19       "last_updated_at": "2024-02-10T14:45:00Z",
20       "last_updated_by": "bob.smith",
21       "version_count": 3
22     }
23   ],
24   "sortableBy": [
25     "name",
26     "created_at",
27     "last_updated_at"
28   ]
29 }

Get prompts scoped to a project

Path parameters

projectIdstringRequiredformat: "uuid"

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

namestringOptional

sortingstringOptional

filtersstringOptional

Response

pageinteger or null

sizeinteger or null

totallong or null

contentlist of objects or null

sortableBylist of strings or null