Deploy a prompt version

import requests
url = "https://api.respan.ai/api/prompts/prompt_id/deployments/"
payload = { "version": 3 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "version": 3,
  "description": "Improved system prompt for better context handling and user engagement",
  "messages": [
    "System prompt updated to include user context and recent conversation history for enhanced responses."
  ],
  "model": "gpt-4",
  "readonly": true,
  "is_deployed": true,
  "edited_by": {
    "id": 456,
    "email": "jane.doe@respan.ai"
  },
  "created_at": "2024-05-15T09:30:00Z"
}

Sets a committed version as the live (deployed) version. The version must be committed (readonly) first. Deploying a new version automatically un-deploys the previous live version.

version integer required: The version number to deploy.

Python

1 import requests
2 
3 url = "https://api.respan.ai/api/prompts/{prompt_id}/deployments/"
4 api_key = "YOUR_RESPAN_API_KEY"
5 headers = {
6     "Authorization": f"Bearer {api_key}",
7     "Content-Type": "application/json"
8 }
9 data = {
10     "version": 3
11 }
12 
13 response = requests.post(url, headers=headers, json=data)
14 print(response.json())

TypeScript

1 fetch('https://api.respan.ai/api/prompts/{prompt_id}/deployments/', {
2   method: 'POST',
3   headers: {
4     'Content-Type': 'application/json',
5     'Authorization': 'Bearer YOUR_RESPAN_API_KEY'
6   },
7   body: JSON.stringify({
8     version: 3
9   })
10 })
11 .then(response => response.json())
12 .then(data => console.log(data));

Sets a committed version as the live (deployed) version. The version must be committed (readonly) first. Deploying a new version automatically un-deploys the previous live version. - `version` *integer* **required**: The version number to deploy. ```Python Python import requests url = "https://api.respan.ai/api/prompts/{prompt_id}/deployments/" api_key = "YOUR_RESPAN_API_KEY" headers = { "Authorization": f"Bearer {api_key}", "Content-Type": "application/json" } data = { "version": 3 } response = requests.post(url, headers=headers, json=data) print(response.json()) ``` ```TypeScript TypeScript fetch('https://api.respan.ai/api/prompts/{prompt_id}/deployments/', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer YOUR_RESPAN_API_KEY' }, body: JSON.stringify({ version: 3 }) }) .then(response => response.json()) .then(data => console.log(data)); ```

Authentication

AuthorizationBearer

API key authentication. Get your API key from https://platform.respan.ai/platform/api-keys

Path parameters

prompt_idstringRequired

The unique prompt identifier

Request

This endpoint expects an object.

versionintegerRequired

The committed version number to deploy

Response

Version deployed successfully

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

Sets a committed version as the live (deployed) version. The version must be committed (readonly) first. Deploying a new version automatically un-deploys the previous live version.

version integer required: The version number to deploy.

Python

1 import requests
2 
3 url = "https://api.respan.ai/api/prompts/{prompt_id}/deployments/"
4 api_key = "YOUR_RESPAN_API_KEY"
5 headers = {
6     "Authorization": f"Bearer {api_key}",
7     "Content-Type": "application/json"
8 }
9 data = {
10     "version": 3
11 }
12 
13 response = requests.post(url, headers=headers, json=data)
14 print(response.json())

TypeScript

1 fetch('https://api.respan.ai/api/prompts/{prompt_id}/deployments/', {
2   method: 'POST',
3   headers: {
4     'Content-Type': 'application/json',
5     'Authorization': 'Bearer YOUR_RESPAN_API_KEY'
6   },
7   body: JSON.stringify({
8     version: 3
9   })
10 })
11 .then(response => response.json())
12 .then(data => console.log(data));

1	import requests
2
3	url = "https://api.respan.ai/api/prompts/{prompt_id}/deployments/"
4	api_key = "YOUR_RESPAN_API_KEY"
5	headers = {
6	"Authorization": f"Bearer {api_key}",
7	"Content-Type": "application/json"
8	}
9	data = {
10	"version": 3
11	}
12
13	response = requests.post(url, headers=headers, json=data)
14	print(response.json())

1	fetch('https://api.respan.ai/api/prompts/{prompt_id}/deployments/', {
2	method: 'POST',
3	headers: {
4	'Content-Type': 'application/json',
5	'Authorization': 'Bearer YOUR_RESPAN_API_KEY'
6	},
7	body: JSON.stringify({
8	version: 3
9	})
10	})
11	.then(response => response.json())
12	.then(data => console.log(data));