Apply Overlay Endpoint
curl --request POST \
--url https://api.promptguard.co/api/v1/overlays/apply \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"delta": {
"detection_levels": {},
"toxicity_threshold": 0.5,
"add_custom_patterns": [
"<string>"
],
"add_blocked_domains": [
"<string>"
],
"guardrails": {}
},
"project_id": "<string>",
"acknowledge_loosening": false
}
'import requests
url = "https://api.promptguard.co/api/v1/overlays/apply"
payload = {
"name": "<string>",
"delta": {
"detection_levels": {},
"toxicity_threshold": 0.5,
"add_custom_patterns": ["<string>"],
"add_blocked_domains": ["<string>"],
"guardrails": {}
},
"project_id": "<string>",
"acknowledge_loosening": False
}
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: '<string>',
delta: {
detection_levels: {},
toxicity_threshold: 0.5,
add_custom_patterns: ['<string>'],
add_blocked_domains: ['<string>'],
guardrails: {}
},
project_id: '<string>',
acknowledge_loosening: false
})
};
fetch('https://api.promptguard.co/api/v1/overlays/apply', 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.promptguard.co/api/v1/overlays/apply",
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' => '<string>',
'delta' => [
'detection_levels' => [
],
'toxicity_threshold' => 0.5,
'add_custom_patterns' => [
'<string>'
],
'add_blocked_domains' => [
'<string>'
],
'guardrails' => [
]
],
'project_id' => '<string>',
'acknowledge_loosening' => false
]),
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.promptguard.co/api/v1/overlays/apply"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"delta\": {\n \"detection_levels\": {},\n \"toxicity_threshold\": 0.5,\n \"add_custom_patterns\": [\n \"<string>\"\n ],\n \"add_blocked_domains\": [\n \"<string>\"\n ],\n \"guardrails\": {}\n },\n \"project_id\": \"<string>\",\n \"acknowledge_loosening\": false\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.promptguard.co/api/v1/overlays/apply")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"delta\": {\n \"detection_levels\": {},\n \"toxicity_threshold\": 0.5,\n \"add_custom_patterns\": [\n \"<string>\"\n ],\n \"add_blocked_domains\": [\n \"<string>\"\n ],\n \"guardrails\": {}\n },\n \"project_id\": \"<string>\",\n \"acknowledge_loosening\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.promptguard.co/api/v1/overlays/apply")
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\": \"<string>\",\n \"delta\": {\n \"detection_levels\": {},\n \"toxicity_threshold\": 0.5,\n \"add_custom_patterns\": [\n \"<string>\"\n ],\n \"add_blocked_domains\": [\n \"<string>\"\n ],\n \"guardrails\": {}\n },\n \"project_id\": \"<string>\",\n \"acknowledge_loosening\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"version": 123,
"status": "<string>",
"project_id": "<string>",
"warnings": [
{
"kind": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Apply Overlay Endpoint
Promote the overlay to active as a new version for the key’s scope.
POST
/
api
/
v1
/
overlays
/
apply
Apply Overlay Endpoint
curl --request POST \
--url https://api.promptguard.co/api/v1/overlays/apply \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"delta": {
"detection_levels": {},
"toxicity_threshold": 0.5,
"add_custom_patterns": [
"<string>"
],
"add_blocked_domains": [
"<string>"
],
"guardrails": {}
},
"project_id": "<string>",
"acknowledge_loosening": false
}
'import requests
url = "https://api.promptguard.co/api/v1/overlays/apply"
payload = {
"name": "<string>",
"delta": {
"detection_levels": {},
"toxicity_threshold": 0.5,
"add_custom_patterns": ["<string>"],
"add_blocked_domains": ["<string>"],
"guardrails": {}
},
"project_id": "<string>",
"acknowledge_loosening": False
}
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: '<string>',
delta: {
detection_levels: {},
toxicity_threshold: 0.5,
add_custom_patterns: ['<string>'],
add_blocked_domains: ['<string>'],
guardrails: {}
},
project_id: '<string>',
acknowledge_loosening: false
})
};
fetch('https://api.promptguard.co/api/v1/overlays/apply', 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.promptguard.co/api/v1/overlays/apply",
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' => '<string>',
'delta' => [
'detection_levels' => [
],
'toxicity_threshold' => 0.5,
'add_custom_patterns' => [
'<string>'
],
'add_blocked_domains' => [
'<string>'
],
'guardrails' => [
]
],
'project_id' => '<string>',
'acknowledge_loosening' => false
]),
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.promptguard.co/api/v1/overlays/apply"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"delta\": {\n \"detection_levels\": {},\n \"toxicity_threshold\": 0.5,\n \"add_custom_patterns\": [\n \"<string>\"\n ],\n \"add_blocked_domains\": [\n \"<string>\"\n ],\n \"guardrails\": {}\n },\n \"project_id\": \"<string>\",\n \"acknowledge_loosening\": false\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.promptguard.co/api/v1/overlays/apply")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"delta\": {\n \"detection_levels\": {},\n \"toxicity_threshold\": 0.5,\n \"add_custom_patterns\": [\n \"<string>\"\n ],\n \"add_blocked_domains\": [\n \"<string>\"\n ],\n \"guardrails\": {}\n },\n \"project_id\": \"<string>\",\n \"acknowledge_loosening\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.promptguard.co/api/v1/overlays/apply")
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\": \"<string>\",\n \"delta\": {\n \"detection_levels\": {},\n \"toxicity_threshold\": 0.5,\n \"add_custom_patterns\": [\n \"<string>\"\n ],\n \"add_blocked_domains\": [\n \"<string>\"\n ],\n \"guardrails\": {}\n },\n \"project_id\": \"<string>\",\n \"acknowledge_loosening\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"version": 123,
"status": "<string>",
"project_id": "<string>",
"warnings": [
{
"kind": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
PromptGuard API key for developer endpoints. Keys start with pg_live_ and are created in the dashboard.
Body
application/json
Required string length:
1 - 120Additive deltas over a base policy config.
Everything here is meant to tighten. Loosening ops (raising a threshold, dropping a detection level toward permissive, disabling a guardrail) are permitted to be expressed but are flagged as warnings in the diff.
Show child attributes
Show child attributes
⌘I