Create a prompt version
curl --request POST \
--url https://api.zespan.com/v1/prompts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "support-reply",
"type": "chat",
"prompt": [
{
"role": "system",
"content": "You are a concise support assistant."
},
{
"role": "user",
"content": "{{question}}"
}
],
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"temperature": 0.2,
"max_tokens": 512
},
"labels": [
"production"
],
"tags": [
"support"
],
"commitMessage": "Tighten system instructions",
"folder": "support/inbound"
}
'import requests
url = "https://api.zespan.com/v1/prompts"
payload = {
"name": "support-reply",
"type": "chat",
"prompt": [
{
"role": "system",
"content": "You are a concise support assistant."
},
{
"role": "user",
"content": "{{question}}"
}
],
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"temperature": 0.2,
"max_tokens": 512
},
"labels": ["production"],
"tags": ["support"],
"commitMessage": "Tighten system instructions",
"folder": "support/inbound"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'support-reply',
type: 'chat',
prompt: [
{role: 'system', content: 'You are a concise support assistant.'},
{role: 'user', content: '{{question}}'}
],
projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {temperature: 0.2, max_tokens: 512},
labels: ['production'],
tags: ['support'],
commitMessage: 'Tighten system instructions',
folder: 'support/inbound'
})
};
fetch('https://api.zespan.com/v1/prompts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zespan.com/v1/prompts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'support-reply',
'type' => 'chat',
'prompt' => [
[
'role' => 'system',
'content' => 'You are a concise support assistant.'
],
[
'role' => 'user',
'content' => '{{question}}'
]
],
'projectId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
'temperature' => 0.2,
'max_tokens' => 512
],
'labels' => [
'production'
],
'tags' => [
'support'
],
'commitMessage' => 'Tighten system instructions',
'folder' => 'support/inbound'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zespan.com/v1/prompts"
payload := strings.NewReader("{\n \"name\": \"support-reply\",\n \"type\": \"chat\",\n \"prompt\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a concise support assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"{{question}}\"\n }\n ],\n \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"temperature\": 0.2,\n \"max_tokens\": 512\n },\n \"labels\": [\n \"production\"\n ],\n \"tags\": [\n \"support\"\n ],\n \"commitMessage\": \"Tighten system instructions\",\n \"folder\": \"support/inbound\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zespan.com/v1/prompts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"support-reply\",\n \"type\": \"chat\",\n \"prompt\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a concise support assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"{{question}}\"\n }\n ],\n \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"temperature\": 0.2,\n \"max_tokens\": 512\n },\n \"labels\": [\n \"production\"\n ],\n \"tags\": [\n \"support\"\n ],\n \"commitMessage\": \"Tighten system instructions\",\n \"folder\": \"support/inbound\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zespan.com/v1/prompts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"support-reply\",\n \"type\": \"chat\",\n \"prompt\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a concise support assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"{{question}}\"\n }\n ],\n \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"temperature\": 0.2,\n \"max_tokens\": 512\n },\n \"labels\": [\n \"production\"\n ],\n \"tags\": [\n \"support\"\n ],\n \"commitMessage\": \"Tighten system instructions\",\n \"folder\": \"support/inbound\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "support-reply",
"version": 3,
"prompt": "<string>",
"config": {},
"labels": [
"production",
"latest"
],
"tags": [
"<string>"
],
"folder": "<string>",
"commitMessage": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"resolvedPrompt": "<unknown>"
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}Create a prompt version
Create a new version of a prompt. If the named prompt already exists a new incremented version is created; otherwise version 1 is created. The latest label is always applied automatically.
POST
/
v1
/
prompts
Create a prompt version
curl --request POST \
--url https://api.zespan.com/v1/prompts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "support-reply",
"type": "chat",
"prompt": [
{
"role": "system",
"content": "You are a concise support assistant."
},
{
"role": "user",
"content": "{{question}}"
}
],
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"temperature": 0.2,
"max_tokens": 512
},
"labels": [
"production"
],
"tags": [
"support"
],
"commitMessage": "Tighten system instructions",
"folder": "support/inbound"
}
'import requests
url = "https://api.zespan.com/v1/prompts"
payload = {
"name": "support-reply",
"type": "chat",
"prompt": [
{
"role": "system",
"content": "You are a concise support assistant."
},
{
"role": "user",
"content": "{{question}}"
}
],
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"temperature": 0.2,
"max_tokens": 512
},
"labels": ["production"],
"tags": ["support"],
"commitMessage": "Tighten system instructions",
"folder": "support/inbound"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'support-reply',
type: 'chat',
prompt: [
{role: 'system', content: 'You are a concise support assistant.'},
{role: 'user', content: '{{question}}'}
],
projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {temperature: 0.2, max_tokens: 512},
labels: ['production'],
tags: ['support'],
commitMessage: 'Tighten system instructions',
folder: 'support/inbound'
})
};
fetch('https://api.zespan.com/v1/prompts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zespan.com/v1/prompts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'support-reply',
'type' => 'chat',
'prompt' => [
[
'role' => 'system',
'content' => 'You are a concise support assistant.'
],
[
'role' => 'user',
'content' => '{{question}}'
]
],
'projectId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
'temperature' => 0.2,
'max_tokens' => 512
],
'labels' => [
'production'
],
'tags' => [
'support'
],
'commitMessage' => 'Tighten system instructions',
'folder' => 'support/inbound'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zespan.com/v1/prompts"
payload := strings.NewReader("{\n \"name\": \"support-reply\",\n \"type\": \"chat\",\n \"prompt\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a concise support assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"{{question}}\"\n }\n ],\n \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"temperature\": 0.2,\n \"max_tokens\": 512\n },\n \"labels\": [\n \"production\"\n ],\n \"tags\": [\n \"support\"\n ],\n \"commitMessage\": \"Tighten system instructions\",\n \"folder\": \"support/inbound\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zespan.com/v1/prompts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"support-reply\",\n \"type\": \"chat\",\n \"prompt\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a concise support assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"{{question}}\"\n }\n ],\n \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"temperature\": 0.2,\n \"max_tokens\": 512\n },\n \"labels\": [\n \"production\"\n ],\n \"tags\": [\n \"support\"\n ],\n \"commitMessage\": \"Tighten system instructions\",\n \"folder\": \"support/inbound\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zespan.com/v1/prompts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"support-reply\",\n \"type\": \"chat\",\n \"prompt\": [\n {\n \"role\": \"system\",\n \"content\": \"You are a concise support assistant.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"{{question}}\"\n }\n ],\n \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"temperature\": 0.2,\n \"max_tokens\": 512\n },\n \"labels\": [\n \"production\"\n ],\n \"tags\": [\n \"support\"\n ],\n \"commitMessage\": \"Tighten system instructions\",\n \"folder\": \"support/inbound\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "support-reply",
"version": 3,
"prompt": "<string>",
"config": {},
"labels": [
"production",
"latest"
],
"tags": [
"<string>"
],
"folder": "<string>",
"commitMessage": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"resolvedPrompt": "<unknown>"
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}Authorizations
Project API key. Manage keys in the Zespan dashboard under project settings.
Body
application/json
Minimum string length:
1Example:
"support-reply"
Available options:
text, chat Example:
"chat"
Prompt content. A string for text prompts, or an array of chat messages for chat prompts.
Example:
[ { "role": "system", "content": "You are a concise support assistant." }, { "role": "user", "content": "{{question}}" } ]
Optional when authenticating with an API key.
Model configuration (temperature, max_tokens, etc.).
Example:
{ "temperature": 0.2, "max_tokens": 512 }
Example:
["production"]
Example:
["support"]
Example:
"Tighten system instructions"
Example:
"support/inbound"
Response
Prompt version created.
A single prompt version.
Example:
"support-reply"
Example:
3
Available options:
text, chat Prompt content — a string for text prompts, or an array of chat messages.
Example:
["production", "latest"]
Prompt content with dependencies inlined (present on single-prompt fetch).
Was this page helpful?
⌘I

