curl --request PUT \
--url https://api.portkey.ai/v1/prompts/{promptId} \
--header 'Content-Type: application/json' \
--header 'x-portkey-api-key: <api-key>' \
--data '
{
"patch": true,
"name": "<string>",
"collection_id": "<string>",
"string": "<string>",
"parameters": {},
"model": "<string>",
"virtual_key": "<string>",
"version_description": "<string>",
"functions": [
{}
],
"tools": [
{}
],
"tool_choice": {},
"prompt_metadata": {}
}
'import requests
url = "https://api.portkey.ai/v1/prompts/{promptId}"
payload = {
"patch": True,
"name": "<string>",
"collection_id": "<string>",
"string": "<string>",
"parameters": {},
"model": "<string>",
"virtual_key": "<string>",
"version_description": "<string>",
"functions": [{}],
"tools": [{}],
"tool_choice": {},
"prompt_metadata": {}
}
headers = {
"x-portkey-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-portkey-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patch: true,
name: '<string>',
collection_id: '<string>',
string: '<string>',
parameters: {},
model: '<string>',
virtual_key: '<string>',
version_description: '<string>',
functions: [{}],
tools: [{}],
tool_choice: {},
prompt_metadata: {}
})
};
fetch('https://api.portkey.ai/v1/prompts/{promptId}', 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.portkey.ai/v1/prompts/{promptId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'patch' => true,
'name' => '<string>',
'collection_id' => '<string>',
'string' => '<string>',
'parameters' => [
],
'model' => '<string>',
'virtual_key' => '<string>',
'version_description' => '<string>',
'functions' => [
[
]
],
'tools' => [
[
]
],
'tool_choice' => [
],
'prompt_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-portkey-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.portkey.ai/v1/prompts/{promptId}"
payload := strings.NewReader("{\n \"patch\": true,\n \"name\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"string\": \"<string>\",\n \"parameters\": {},\n \"model\": \"<string>\",\n \"virtual_key\": \"<string>\",\n \"version_description\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"tools\": [\n {}\n ],\n \"tool_choice\": {},\n \"prompt_metadata\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-portkey-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.put("https://api.portkey.ai/v1/prompts/{promptId}")
.header("x-portkey-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patch\": true,\n \"name\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"string\": \"<string>\",\n \"parameters\": {},\n \"model\": \"<string>\",\n \"virtual_key\": \"<string>\",\n \"version_description\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"tools\": [\n {}\n ],\n \"tool_choice\": {},\n \"prompt_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portkey.ai/v1/prompts/{promptId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-portkey-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patch\": true,\n \"name\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"string\": \"<string>\",\n \"parameters\": {},\n \"model\": \"<string>\",\n \"virtual_key\": \"<string>\",\n \"version_description\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"tools\": [\n {}\n ],\n \"tool_choice\": {},\n \"prompt_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"prompt_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Update Prompt
Update a prompt’s metadata and/or create a new version with updated template content.
Partial version updates: Set patch: true to perform a partial update of version fields (string, parameters, model, virtual_key, version_description, functions, tools, tool_choice, is_raw_template, prompt_metadata). When enabled, any version fields omitted from the request are backfilled from the current latest version, allowing you to update only the fields you need. When patch is omitted or false, all version fields must be provided together (original strict validation).
Metadata-only updates: Fields like name, collection_id, version_description, and virtual_key can always be updated independently without affecting versioning.
curl --request PUT \
--url https://api.portkey.ai/v1/prompts/{promptId} \
--header 'Content-Type: application/json' \
--header 'x-portkey-api-key: <api-key>' \
--data '
{
"patch": true,
"name": "<string>",
"collection_id": "<string>",
"string": "<string>",
"parameters": {},
"model": "<string>",
"virtual_key": "<string>",
"version_description": "<string>",
"functions": [
{}
],
"tools": [
{}
],
"tool_choice": {},
"prompt_metadata": {}
}
'import requests
url = "https://api.portkey.ai/v1/prompts/{promptId}"
payload = {
"patch": True,
"name": "<string>",
"collection_id": "<string>",
"string": "<string>",
"parameters": {},
"model": "<string>",
"virtual_key": "<string>",
"version_description": "<string>",
"functions": [{}],
"tools": [{}],
"tool_choice": {},
"prompt_metadata": {}
}
headers = {
"x-portkey-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-portkey-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patch: true,
name: '<string>',
collection_id: '<string>',
string: '<string>',
parameters: {},
model: '<string>',
virtual_key: '<string>',
version_description: '<string>',
functions: [{}],
tools: [{}],
tool_choice: {},
prompt_metadata: {}
})
};
fetch('https://api.portkey.ai/v1/prompts/{promptId}', 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.portkey.ai/v1/prompts/{promptId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'patch' => true,
'name' => '<string>',
'collection_id' => '<string>',
'string' => '<string>',
'parameters' => [
],
'model' => '<string>',
'virtual_key' => '<string>',
'version_description' => '<string>',
'functions' => [
[
]
],
'tools' => [
[
]
],
'tool_choice' => [
],
'prompt_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-portkey-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.portkey.ai/v1/prompts/{promptId}"
payload := strings.NewReader("{\n \"patch\": true,\n \"name\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"string\": \"<string>\",\n \"parameters\": {},\n \"model\": \"<string>\",\n \"virtual_key\": \"<string>\",\n \"version_description\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"tools\": [\n {}\n ],\n \"tool_choice\": {},\n \"prompt_metadata\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-portkey-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.put("https://api.portkey.ai/v1/prompts/{promptId}")
.header("x-portkey-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patch\": true,\n \"name\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"string\": \"<string>\",\n \"parameters\": {},\n \"model\": \"<string>\",\n \"virtual_key\": \"<string>\",\n \"version_description\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"tools\": [\n {}\n ],\n \"tool_choice\": {},\n \"prompt_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portkey.ai/v1/prompts/{promptId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-portkey-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patch\": true,\n \"name\": \"<string>\",\n \"collection_id\": \"<string>\",\n \"string\": \"<string>\",\n \"parameters\": {},\n \"model\": \"<string>\",\n \"virtual_key\": \"<string>\",\n \"version_description\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"tools\": [\n {}\n ],\n \"tool_choice\": {},\n \"prompt_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"prompt_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Portkey is now PRISMA AIRS AI Gateway. See it in action.
Body
When true, enables partial version updates. Missing version fields (string, parameters, model) are backfilled from the current latest version, so you only need to provide the fields you want to change. When false or omitted, the original strict validation is preserved for backward compatibility.
Was this page helpful?

