Retrieve a prompt version

GET

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

GET

/api/prompts/:prompt_id/versions/:version/

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

1 {
2   "id": "pv_abc123",
3   "prompt_version_id": "pv_abc123",
4   "version": 3,
5   "description": "Added context variable",
6   "messages": [
7     {
8       "role": "system",
9       "content": "You are a helpful assistant. Context: {{context}}"
10     },
11     {
12       "role": "user",
13       "content": "{{user_query}}"
14     }
15   ],
16   "thinking": null,
17   "model": "gpt-4o",
18   "stream": false,
19   "temperature": 0.7,
20   "max_tokens": 2048,
21   "top_p": 1,
22   "frequency_penalty": 0,
23   "presence_penalty": 0,
24   "reasoning_effort": null,
25   "verbosity": null,
26   "seed": null,
27   "variables": {
28     "context": "",
29     "user_query": ""
30   },
31   "fallback_models": [
32     "gpt-4o-mini"
33   ],
34   "load_balance_models": [
35     {
36       "model": "gpt-4o",
37       "weight": 0.8
38     },
39     {
40       "model": "gpt-4o-mini",
41       "weight": 0.2
42     }
43   ],
44   "tools": [
45     {
46       "type": "function",
47       "function": {
48         "name": "search_knowledge_base"
49       }
50     }
51   ],
52   "tool_choice": "auto",
53   "response_format": null,
54   "json_schema": null,
55   "is_enforcing_response_format": false,
56   "readonly": false,
57   "is_deployed": false,
58   "edited_by": {
59     "id": 123,
60     "email": "user@example.com",
61     "first_name": "John",
62     "last_name": "Doe"
63   },
64   "created_at": "2026-01-20T10:30:00Z",
65   "updated_at": "2026-01-20T10:30:00Z"
66 }

Retrieve a specific version of a prompt.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

prompt_idstringRequired

The unique prompt identifier.

versionintegerRequired

The prompt version number.

Response

Prompt version details.

idstringOptional

prompt_version_idstringOptional

versionintegerOptional

descriptionstring or nullOptional

messageslist of maps from strings to anyOptional

thinkingobject or nullOptional

modelstringOptional

streambooleanOptional

temperaturedouble or nullOptional

max_tokensinteger or nullOptional

top_pdouble or nullOptional

frequency_penaltydouble or nullOptional

presence_penaltydouble or nullOptional

reasoning_effortstring or nullOptional

verbositystring or nullOptional

seedinteger or nullOptional

variablesobjectOptional

fallback_modelslist of strings or nullOptional

load_balance_modelslist of objects or nullOptional

toolslist of objects or nullOptional

tool_choicestring or map from strings to anyOptional

response_formatobject or nullOptional

json_schemaobject or nullOptional

is_enforcing_response_formatbooleanOptional

readonlybooleanOptional

is_deployedbooleanOptional

edited_byobjectOptional

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

401

Unauthorized Error

404

Not Found Error