Deploy a prompt version

POST

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

POST

/api/prompts/:prompt_id/deployments/

$ curl -X POST https://api.respan.ai/api/prompts/prompt_id/deployments/ \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "version": 3
> }'

1 {
2   "id": "pv_abc123",
3   "prompt_version_id": "pv_abc123",
4   "version": 3,
5   "description": "Improved system prompt for better context handling",
6   "messages": [
7     {
8       "role": "system",
9       "content": "You are a helpful assistant. Context: {{context}}"
10     }
11   ],
12   "model": "gpt-4o",
13   "readonly": true,
14   "is_deployed": true,
15   "edited_by": {
16     "id": 123,
17     "email": "user@example.com",
18     "first_name": "John",
19     "last_name": "Doe"
20   },
21   "created_at": "2026-02-27T10:00:00Z",
22   "updated_at": "2026-02-27T10:00:00Z"
23 }

Deploy a committed version as the live version for this 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.

Request

This endpoint expects an object.

versionintegerRequired

Version number to deploy as live.

Response

Version deployed successfully.

idstringOptional

prompt_version_idstringOptional

versionintegerOptional

descriptionstring or nullOptional

messageslist of maps from strings to anyOptional

modelstringOptional

readonlybooleanOptional

is_deployedbooleanOptional

edited_byobjectOptional

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error