Retrieve a prompt

GET

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

GET

/api/prompts/:prompt_id/

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

1 {
2   "id": "prompt_abc123",
3   "name": "Customer Support Assistant",
4   "description": "Handles customer support queries with empathy",
5   "prompt_slug": "customer-support-assistant",
6   "tags": [
7     {
8       "id": "tag_abc123",
9       "name": "support",
10       "color": "#3B82F6",
11       "created_at": "2026-01-01T00:00:00Z",
12       "updated_at": "2026-01-01T00:00:00Z"
13     }
14   ],
15   "current_version": {
16     "version": 3,
17     "model": "gpt-4o",
18     "updated_at": "2026-01-20T10:30:00Z"
19   },
20   "live_version": {
21     "version": 2,
22     "model": "gpt-4o-mini",
23     "updated_at": "2026-01-15T08:00:00Z"
24   },
25   "created_at": "2026-01-01T00:00:00Z",
26   "updated_at": "2026-01-20T10:30:00Z"
27 }

Retrieve a prompt template by ID, including its current and live versions.

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.

Response

Prompt details.

idstringOptional

The unique prompt identifier.

namestringOptional

descriptionstring or nullOptional

prompt_slugstring or nullOptional

tagslist of objectsOptional

current_versionobject or nullOptional

live_versionobject or nullOptional

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

401

Unauthorized Error

404

Not Found Error