Retrieve

GET

https://api.respan.ai/prompts/:prompt_id/

GET

/prompts/:prompt_id/

$ curl https://api.respan.ai/prompts/prompt_id/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": "string",
3   "current_version": {
4     "id": "string",
5     "edited_by": {
6       "id": 1,
7       "email": "string",
8       "name": "string",
9       "username": "string",
10       "first_name": "string",
11       "last_name": "string"
12     },
13     "prompt_version_id": "string",
14     "updated_at": "2024-01-15T09:30:00Z",
15     "prompt": 1,
16     "parent_prompt": "string",
17     "messages": [
18       {
19         "role": "string",
20         "content": "string",
21         "id": "string",
22         "model": "string",
23         "tool_calls": [
24           {}
25         ],
26         "tool_call_id": "string"
27       }
28     ],
29     "variables": {},
30     "tools": [
31       {
32         "type": "function",
33         "function": {
34           "name": "string",
35           "description": "string",
36           "strict": true,
37           "additionalProperties": true,
38           "parameters": {
39             "type": "object",
40             "properties": {},
41             "required": [
42               "string"
43             ]
44           }
45         }
46       }
47     ],
48     "load_balance_models": [
49       {
50         "model": "string",
51         "weight": 1.1,
52         "credentials": {}
53       }
54     ],
55     "thinking": {
56       "type": "enabled",
57       "budget_tokens": 1
58     },
59     "tool_choice": "string",
60     "response_format": {},
61     "json_schema": {},
62     "is_deployed": true,
63     "description": "string",
64     "created_at": "2024-01-15T09:30:00Z",
65     "version": 1,
66     "model": "string",
67     "stream": true,
68     "temperature": 1.1,
69     "max_tokens": 1,
70     "top_p": 1.1,
71     "frequency_penalty": 1.1,
72     "presence_penalty": 1.1,
73     "reasoning_effort": "string",
74     "verbosity": "string",
75     "seed": 1,
76     "readonly": true,
77     "fallback_models": [
78       "string"
79     ],
80     "is_enforcing_response_format": true
81   },
82   "full_prompt_id": "string",
83   "created_by": 1,
84   "tags": [
85     {
86       "id": "string",
87       "name": "string",
88       "color": "string",
89       "created_at": "2024-01-15T09:30:00Z",
90       "updated_at": "2024-01-15T09:30:00Z"
91     }
92   ],
93   "prompt_versions": [
94     {
95       "id": 1,
96       "edited_by": {
97         "id": 1,
98         "email": "string",
99         "name": "string",
100         "username": "string",
101         "first_name": "string",
102         "last_name": "string"
103       },
104       "updated_at": "2024-01-15T09:30:00Z",
105       "prompt": 1,
106       "parent_prompt": "string",
107       "messages": [
108         {
109           "role": "string",
110           "content": "string",
111           "id": "string",
112           "model": "string",
113           "tool_calls": [
114             {}
115           ],
116           "tool_call_id": "string"
117         }
118       ],
119       "variables": {},
120       "tools": [
121         {
122           "type": "function",
123           "function": {
124             "name": "string",
125             "description": "string",
126             "strict": true,
127             "additionalProperties": true,
128             "parameters": {
129               "type": "object",
130               "properties": {},
131               "required": [
132                 "string"
133               ]
134             }
135           }
136         }
137       ],
138       "load_balance_models": [
139         {
140           "model": "string",
141           "weight": 1.1,
142           "credentials": {}
143         }
144       ],
145       "thinking": {
146         "type": "enabled",
147         "budget_tokens": 1
148       },
149       "tool_choice": "string",
150       "response_format": {},
151       "json_schema": {},
152       "is_deployed": true,
153       "prompt_version_id": "string",
154       "description": "string",
155       "created_at": "2024-01-15T09:30:00Z",
156       "version": 1,
157       "model": "string",
158       "stream": true,
159       "temperature": 1.1,
160       "max_tokens": 1,
161       "top_p": 1.1,
162       "frequency_penalty": 1.1,
163       "presence_penalty": 1.1,
164       "reasoning_effort": "string",
165       "verbosity": "string",
166       "seed": 1,
167       "readonly": true,
168       "fallback_models": [
169         "string"
170       ],
171       "is_enforcing_response_format": true
172     }
173   ],
174   "live_version": {
175     "id": "string",
176     "edited_by": {
177       "id": 1,
178       "email": "string",
179       "name": "string",
180       "username": "string",
181       "first_name": "string",
182       "last_name": "string"
183     },
184     "prompt_version_id": "string",
185     "updated_at": "2024-01-15T09:30:00Z",
186     "prompt": 1,
187     "parent_prompt": "string",
188     "messages": [
189       {
190         "role": "string",
191         "content": "string",
192         "id": "string",
193         "model": "string",
194         "tool_calls": [
195           {}
196         ],
197         "tool_call_id": "string"
198       }
199     ],
200     "variables": {},
201     "tools": [
202       {
203         "type": "function",
204         "function": {
205           "name": "string",
206           "description": "string",
207           "strict": true,
208           "additionalProperties": true,
209           "parameters": {
210             "type": "object",
211             "properties": {},
212             "required": [
213               "string"
214             ]
215           }
216         }
217       }
218     ],
219     "load_balance_models": [
220       {
221         "model": "string",
222         "weight": 1.1,
223         "credentials": {}
224       }
225     ],
226     "thinking": {
227       "type": "enabled",
228       "budget_tokens": 1
229     },
230     "tool_choice": "string",
231     "response_format": {},
232     "json_schema": {},
233     "is_deployed": true,
234     "description": "string",
235     "created_at": "2024-01-15T09:30:00Z",
236     "version": 1,
237     "model": "string",
238     "stream": true,
239     "temperature": 1.1,
240     "max_tokens": 1,
241     "top_p": 1.1,
242     "frequency_penalty": 1.1,
243     "presence_penalty": 1.1,
244     "reasoning_effort": "string",
245     "verbosity": "string",
246     "seed": 1,
247     "readonly": true,
248     "fallback_models": [
249       "string"
250     ],
251     "is_enforcing_response_format": true
252   },
253   "commit_count": 1,
254   "organization": 1,
255   "project": "string",
256   "name": "string",
257   "description": "string",
258   "prompt_id": "string",
259   "prompt_slug": "string",
260   "starred": true,
261   "deleted_at": "2024-01-15T09:30:00Z"
262 }

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

prompt_idstringRequired

Response

idstringRead-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 null

namestring<=100 characters

descriptionstring

prompt_idstring<=70 characters

prompt_slugstring or null<=100 characters

starredboolean

deleted_atdatetime or null