Jwt Prompt Retrieve

GET

https://api.respan.ai/prompts/jwt/prompt/:id/

GET

/prompts/jwt/prompt/:id/

$ curl https://api.respan.ai/prompts/jwt/prompt/1/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "id": 1,
3   "current_version": {
4     "id": 101,
5     "edited_by": {
6       "id": 42,
7       "email": "jane.doe@respan.ai",
8       "name": "Jane Doe",
9       "username": "jdoe",
10       "first_name": "Jane",
11       "last_name": "Doe"
12     },
13     "updated_at": "2024-01-20T11:45:00Z",
14     "prompt": 1,
15     "parent_prompt": null,
16     "messages": [
17       {
18         "role": "system",
19         "content": "Welcome to the customer support assistant prompt.",
20         "id": "msg-001",
21         "model": "gpt-4",
22         "tool_calls": [
23           {}
24         ],
25         "tool_call_id": "tc-12345"
26       }
27     ],
28     "variables": {
29       "customer_name": "string",
30       "issue_type": {
31         "_type": "prompt",
32         "prompt_id": "issue-classification",
33         "version": 2
34       }
35     },
36     "tools": [
37       {
38         "type": "function",
39         "function": {
40           "name": "fetch_customer_data",
41           "description": "Retrieves customer data from the CRM system.",
42           "strict": false,
43           "additionalProperties": false,
44           "parameters": {
45             "type": "object",
46             "properties": {
47               "customer_id": {
48                 "type": "string",
49                 "description": "Unique identifier for the customer"
50               }
51             },
52             "required": [
53               "customer_id"
54             ]
55           }
56         }
57       }
58     ],
59     "load_balance_models": [
60       {
61         "model": "gpt-4",
62         "weight": 0.7,
63         "credentials": {
64           "api_key": "sk-xxxxxx"
65         }
66       },
67       {
68         "model": "gpt-3.5-turbo",
69         "weight": 0.3,
70         "credentials": {
71           "api_key": "sk-yyyyyy"
72         }
73       }
74     ],
75     "thinking": {
76       "type": "enabled",
77       "budget_tokens": 1500
78     },
79     "tool_choice": "fetch_customer_data",
80     "response_format": {
81       "type": "object",
82       "properties": {
83         "response_text": {
84           "type": "string"
85         },
86         "confidence_score": {
87           "type": "number"
88         }
89       }
90     },
91     "json_schema": {
92       "type": "object",
93       "properties": {
94         "response_text": {
95           "type": "string"
96         },
97         "confidence_score": {
98           "type": "number"
99         }
100       },
101       "required": [
102         "response_text"
103       ]
104     },
105     "is_deployed": true,
106     "prompt_version_id": "pv-20240115-01",
107     "description": "Initial version of the customer support prompt.",
108     "created_at": "2024-01-15T09:30:00Z",
109     "version": 1,
110     "model": "gpt-4",
111     "stream": true,
112     "temperature": 0.7,
113     "max_tokens": 1024,
114     "top_p": 0.9,
115     "frequency_penalty": 0,
116     "presence_penalty": 0,
117     "reasoning_effort": "moderate",
118     "verbosity": "concise",
119     "seed": 123456,
120     "readonly": false,
121     "fallback_models": [
122       "gpt-3.5-turbo"
123     ],
124     "is_enforcing_response_format": true
125   },
126   "full_prompt_id": "cust-support-001",
127   "created_by": 42,
128   "tags": [
129     {
130       "id": "tag-001",
131       "name": "support",
132       "color": "#1E90FF",
133       "created_at": "2024-01-10T08:00:00Z",
134       "updated_at": "2024-01-12T08:00:00Z"
135     },
136     {
137       "id": "tag-002",
138       "name": "customer-service",
139       "color": "#32CD32",
140       "created_at": "2024-01-11T09:00:00Z",
141       "updated_at": "2024-01-13T09:00:00Z"
142     }
143   ],
144   "prompt_versions": [
145     {
146       "id": 101,
147       "edited_by": {
148         "id": 42,
149         "email": "jane.doe@respan.ai",
150         "name": "Jane Doe",
151         "username": "jdoe",
152         "first_name": "Jane",
153         "last_name": "Doe"
154       },
155       "updated_at": "2024-01-20T11:45:00Z",
156       "prompt": 1,
157       "parent_prompt": null,
158       "messages": [
159         {
160           "role": "system",
161           "content": "Welcome to the customer support assistant prompt.",
162           "id": "msg-001",
163           "model": "gpt-4",
164           "tool_calls": [
165             {}
166           ],
167           "tool_call_id": "tc-12345"
168         }
169       ],
170       "variables": {
171         "customer_name": "string",
172         "issue_type": {
173           "_type": "prompt",
174           "prompt_id": "issue-classification",
175           "version": 2
176         }
177       },
178       "tools": [
179         {
180           "type": "function",
181           "function": {
182             "name": "fetch_customer_data",
183             "description": "Retrieves customer data from the CRM system.",
184             "strict": false,
185             "additionalProperties": false,
186             "parameters": {
187               "type": "object",
188               "properties": {
189                 "customer_id": {
190                   "type": "string",
191                   "description": "Unique identifier for the customer"
192                 }
193               },
194               "required": [
195                 "customer_id"
196               ]
197             }
198           }
199         }
200       ],
201       "load_balance_models": [
202         {
203           "model": "gpt-4",
204           "weight": 0.7,
205           "credentials": {
206             "api_key": "sk-xxxxxx"
207           }
208         },
209         {
210           "model": "gpt-3.5-turbo",
211           "weight": 0.3,
212           "credentials": {
213             "api_key": "sk-yyyyyy"
214           }
215         }
216       ],
217       "thinking": {
218         "type": "enabled",
219         "budget_tokens": 1500
220       },
221       "tool_choice": "fetch_customer_data",
222       "response_format": {
223         "type": "object",
224         "properties": {
225           "response_text": {
226             "type": "string"
227           },
228           "confidence_score": {
229             "type": "number"
230           }
231         }
232       },
233       "json_schema": {
234         "type": "object",
235         "properties": {
236           "response_text": {
237             "type": "string"
238           },
239           "confidence_score": {
240             "type": "number"
241           }
242         },
243         "required": [
244           "response_text"
245         ]
246       },
247       "is_deployed": true,
248       "prompt_version_id": "pv-20240115-01",
249       "description": "Initial version of the customer support prompt.",
250       "created_at": "2024-01-15T09:30:00Z",
251       "version": 1,
252       "model": "gpt-4",
253       "stream": true,
254       "temperature": 0.7,
255       "max_tokens": 1024,
256       "top_p": 0.9,
257       "frequency_penalty": 0,
258       "presence_penalty": 0,
259       "reasoning_effort": "moderate",
260       "verbosity": "concise",
261       "seed": 123456,
262       "readonly": false,
263       "fallback_models": [
264         "gpt-3.5-turbo"
265       ],
266       "is_enforcing_response_format": true
267     }
268   ],
269   "live_version": {
270     "id": 101,
271     "edited_by": {
272       "id": 42,
273       "email": "jane.doe@respan.ai",
274       "name": "Jane Doe",
275       "username": "jdoe",
276       "first_name": "Jane",
277       "last_name": "Doe"
278     },
279     "updated_at": "2024-01-20T11:45:00Z",
280     "prompt": 1,
281     "parent_prompt": null,
282     "messages": [
283       {
284         "role": "system",
285         "content": "Welcome to the customer support assistant prompt.",
286         "id": "msg-001",
287         "model": "gpt-4",
288         "tool_calls": [
289           {}
290         ],
291         "tool_call_id": "tc-12345"
292       }
293     ],
294     "variables": {
295       "customer_name": "string",
296       "issue_type": {
297         "_type": "prompt",
298         "prompt_id": "issue-classification",
299         "version": 2
300       }
301     },
302     "tools": [
303       {
304         "type": "function",
305         "function": {
306           "name": "fetch_customer_data",
307           "description": "Retrieves customer data from the CRM system.",
308           "strict": false,
309           "additionalProperties": false,
310           "parameters": {
311             "type": "object",
312             "properties": {
313               "customer_id": {
314                 "type": "string",
315                 "description": "Unique identifier for the customer"
316               }
317             },
318             "required": [
319               "customer_id"
320             ]
321           }
322         }
323       }
324     ],
325     "load_balance_models": [
326       {
327         "model": "gpt-4",
328         "weight": 0.7,
329         "credentials": {
330           "api_key": "sk-xxxxxx"
331         }
332       },
333       {
334         "model": "gpt-3.5-turbo",
335         "weight": 0.3,
336         "credentials": {
337           "api_key": "sk-yyyyyy"
338         }
339       }
340     ],
341     "thinking": {
342       "type": "enabled",
343       "budget_tokens": 1500
344     },
345     "tool_choice": "fetch_customer_data",
346     "response_format": {
347       "type": "object",
348       "properties": {
349         "response_text": {
350           "type": "string"
351         },
352         "confidence_score": {
353           "type": "number"
354         }
355       }
356     },
357     "json_schema": {
358       "type": "object",
359       "properties": {
360         "response_text": {
361           "type": "string"
362         },
363         "confidence_score": {
364           "type": "number"
365         }
366       },
367       "required": [
368         "response_text"
369       ]
370     },
371     "is_deployed": true,
372     "prompt_version_id": "pv-20240115-01",
373     "description": "Initial version of the customer support prompt.",
374     "created_at": "2024-01-15T09:30:00Z",
375     "version": 1,
376     "model": "gpt-4",
377     "stream": true,
378     "temperature": 0.7,
379     "max_tokens": 1024,
380     "top_p": 0.9,
381     "frequency_penalty": 0,
382     "presence_penalty": 0,
383     "reasoning_effort": "moderate",
384     "verbosity": "concise",
385     "seed": 123456,
386     "readonly": false,
387     "fallback_models": [
388       "gpt-3.5-turbo"
389     ],
390     "is_enforcing_response_format": true
391   },
392   "commit_count": 3,
393   "organization": 7,
394   "project": "Customer Support AI",
395   "name": "Customer Support Assistant",
396   "description": "Prompt designed to assist customer support agents with common queries.",
397   "prompt_id": "cust-support-001",
398   "prompt_slug": "customer-support-assistant",
399   "starred": true,
400   "deleted_at": null
401 }

Unified view for single prompt operations (retrieve/update/delete). Supports both JWT (dashboard) and API key (public API) authentication.

Superadmin: Can READ any prompt across all organizations via JWT. Can WRITE across organizations via JWT with an active staff_write:prompts (or broad staff_write) scope. Regular users: Can only access prompts in their organization.

JWT auth uses pk lookup, API key auth uses prompt_id (partial match).

Unified view for single prompt operations (retrieve/update/delete). Supports both JWT (dashboard) and API key (public API) authentication. Superadmin: Can READ any prompt across all organizations via JWT. Can WRITE across organizations via JWT with an active staff_write:prompts (or broad staff_write) scope. Regular users: Can only access prompts in their organization. JWT auth uses pk lookup, API key auth uses prompt_id (partial match).

Authentication

AuthorizationBearer

JWT access token or Respan API key

Path parameters

idintegerRequired

Response

idintegerRead-only

current_versionobject

full_prompt_idstringRead-only

created_byintegerRead-only

tagslist of objectsRead-only

prompt_versionslist of objectsRead-only

live_versionobject

commit_countintegerRead-only

organizationinteger

projectstring or nullOptional

namestringOptional<=100 characters

descriptionstringOptional

prompt_idstringOptional<=70 characters

prompt_slugstring or nullOptional<=100 characters

starredbooleanOptional

deleted_atdatetime or nullOptional