List Prompts By Workspace

GET

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

GET

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

$ curl https://host.com/apis/models/v2/workspaces/workspace/prompts \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "name": "llama-3.1-8b",
5       "workspace": "research_team",
6       "created_at": "2024-01-15T09:30:00Z",
7       "updated_at": "2024-01-15T09:30:00Z",
8       "id": "prompt-1234abcd",
9       "project": "project-alpha/v1",
10       "description": "Prompt for summarizing technical documents using LLaMA 3.1 8B model.",
11       "messages": [
12         {
13           "role": "system",
14           "content": "You are a helpful assistant specialized in summarizing technical content."
15         }
16       ],
17       "input_variables": [
18         "document_text"
19       ],
20       "tools": [
21         {
22           "type": "function",
23           "function": {
24             "name": "summarize_text",
25             "description": "Generates a concise summary of the input text.",
26             "parameters": {
27               "type": "object",
28               "properties": {
29                 "text": {
30                   "type": "string",
31                   "description": "The text to summarize"
32                 },
33                 "max_length": {
34                   "type": "integer",
35                   "description": "Maximum length of the summary"
36                 }
37               },
38               "required": [
39                 "text"
40               ]
41             },
42             "strict": true
43           }
44         }
45       ],
46       "tool_choice": "auto",
47       "response_format": {
48         "type": "object",
49         "properties": {
50           "summary": {
51             "type": "string",
52             "description": "The generated summary text"
53           }
54         },
55         "required": [
56           "summary"
57         ]
58       },
59       "inference_params": {
60         "model": "llama-3.1-8b",
61         "temperature": 0.7,
62         "max_tokens": 512,
63         "max_completion_tokens": 512,
64         "top_p": 0.9,
65         "stop": [
66           "\n"
67         ]
68       },
69       "tags": [
70         "summarization",
71         "technical",
72         "llama"
73       ]
74     }
75   ],
76   "pagination": {
77     "page": 1,
78     "page_size": 1,
79     "current_page_size": 1,
80     "total_pages": 1,
81     "total_results": 1
82   },
83   "sort": "created_at",
84   "filter": {}
85 }

List prompts for a specific workspace.

Path parameters

workspacestringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number.

page_sizeintegerOptional1-1000Defaults to 100

Page size.

sortenumOptionalDefaults to created_at

The field to sort by. To sort in decreasing order, use - in front of the field name.

filterobjectOptional

Filter prompts by workspace, project, name, description, created_at, and updated_at.

Response

Return prompts for a workspace

datalist of objects

paginationobject

Pagination information.

sortstring

The field on which the results are sorted.

filtermap from strings to any

Filtering information.

Errors

422

Unprocessable Entity Error