Deploy Prompt Version
curl --request POST \
--url https://api.getmaxim.ai/v1/prompts/deploy \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"promptId": "<string>",
"workspaceId": "<string>",
"deploymentConditions": [
{
"variable": "<string>",
"value": "<string>"
}
],
"versionId": "<string>",
"version": 123
}
'import requests
url = "https://api.getmaxim.ai/v1/prompts/deploy"
payload = {
"promptId": "<string>",
"workspaceId": "<string>",
"deploymentConditions": [
{
"variable": "<string>",
"value": "<string>"
}
],
"versionId": "<string>",
"version": 123
}
headers = {
"x-maxim-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-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
promptId: '<string>',
workspaceId: '<string>',
deploymentConditions: [{variable: '<string>', value: '<string>'}],
versionId: '<string>',
version: 123
})
};
fetch('https://api.getmaxim.ai/v1/prompts/deploy', 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.getmaxim.ai/v1/prompts/deploy",
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([
'promptId' => '<string>',
'workspaceId' => '<string>',
'deploymentConditions' => [
[
'variable' => '<string>',
'value' => '<string>'
]
],
'versionId' => '<string>',
'version' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-maxim-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.getmaxim.ai/v1/prompts/deploy"
payload := strings.NewReader("{\n \"promptId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"deploymentConditions\": [\n {\n \"variable\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"versionId\": \"<string>\",\n \"version\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-maxim-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.getmaxim.ai/v1/prompts/deploy")
.header("x-maxim-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"promptId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"deploymentConditions\": [\n {\n \"variable\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"versionId\": \"<string>\",\n \"version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/prompts/deploy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"promptId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"deploymentConditions\": [\n {\n \"variable\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"versionId\": \"<string>\",\n \"version\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"promptId": "<string>",
"versionId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Prompt Deployment
Deploy Prompt Version
Deploy a prompt version
POST
/
v1
/
prompts
/
deploy
Deploy Prompt Version
curl --request POST \
--url https://api.getmaxim.ai/v1/prompts/deploy \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"promptId": "<string>",
"workspaceId": "<string>",
"deploymentConditions": [
{
"variable": "<string>",
"value": "<string>"
}
],
"versionId": "<string>",
"version": 123
}
'import requests
url = "https://api.getmaxim.ai/v1/prompts/deploy"
payload = {
"promptId": "<string>",
"workspaceId": "<string>",
"deploymentConditions": [
{
"variable": "<string>",
"value": "<string>"
}
],
"versionId": "<string>",
"version": 123
}
headers = {
"x-maxim-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-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
promptId: '<string>',
workspaceId: '<string>',
deploymentConditions: [{variable: '<string>', value: '<string>'}],
versionId: '<string>',
version: 123
})
};
fetch('https://api.getmaxim.ai/v1/prompts/deploy', 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.getmaxim.ai/v1/prompts/deploy",
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([
'promptId' => '<string>',
'workspaceId' => '<string>',
'deploymentConditions' => [
[
'variable' => '<string>',
'value' => '<string>'
]
],
'versionId' => '<string>',
'version' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-maxim-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.getmaxim.ai/v1/prompts/deploy"
payload := strings.NewReader("{\n \"promptId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"deploymentConditions\": [\n {\n \"variable\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"versionId\": \"<string>\",\n \"version\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-maxim-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.getmaxim.ai/v1/prompts/deploy")
.header("x-maxim-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"promptId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"deploymentConditions\": [\n {\n \"variable\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"versionId\": \"<string>\",\n \"version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/prompts/deploy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"promptId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"deploymentConditions\": [\n {\n \"variable\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"versionId\": \"<string>\",\n \"version\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"promptId": "<string>",
"versionId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Authorizations
API key for authentication
Body
application/json
Unique identifier for the prompt
Unique identifier for the workspace
Deployment conditions configuration
Minimum array length:
1Show child attributes
Show child attributes
Unique identifier for the version
Version number
Response
Prompt version deployed successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I