Run a guardrails check
curl --request POST \
--url https://api.zespan.com/v1/guardrails/check \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"text": "My card number is 4111 1111 1111 1111.",
"traceId": "<string>",
"spanId": "<string>",
"model": "gpt-4o",
"operation": "<string>",
"estimatedCost": 123,
"inputTokens": 123,
"agentName": "<string>",
"toolName": "<string>",
"recentToolCalls": [
{
"toolName": "<string>",
"args": "<string>"
}
]
}
'import requests
url = "https://api.zespan.com/v1/guardrails/check"
payload = {
"text": "My card number is 4111 1111 1111 1111.",
"traceId": "<string>",
"spanId": "<string>",
"model": "gpt-4o",
"operation": "<string>",
"estimatedCost": 123,
"inputTokens": 123,
"agentName": "<string>",
"toolName": "<string>",
"recentToolCalls": [
{
"toolName": "<string>",
"args": "<string>"
}
]
}
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({
text: 'My card number is 4111 1111 1111 1111.',
traceId: '<string>',
spanId: '<string>',
model: 'gpt-4o',
operation: '<string>',
estimatedCost: 123,
inputTokens: 123,
agentName: '<string>',
toolName: '<string>',
recentToolCalls: [{toolName: '<string>', args: '<string>'}]
})
};
fetch('https://api.zespan.com/v1/guardrails/check', 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/guardrails/check",
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([
'text' => 'My card number is 4111 1111 1111 1111.',
'traceId' => '<string>',
'spanId' => '<string>',
'model' => 'gpt-4o',
'operation' => '<string>',
'estimatedCost' => 123,
'inputTokens' => 123,
'agentName' => '<string>',
'toolName' => '<string>',
'recentToolCalls' => [
[
'toolName' => '<string>',
'args' => '<string>'
]
]
]),
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/guardrails/check"
payload := strings.NewReader("{\n \"text\": \"My card number is 4111 1111 1111 1111.\",\n \"traceId\": \"<string>\",\n \"spanId\": \"<string>\",\n \"model\": \"gpt-4o\",\n \"operation\": \"<string>\",\n \"estimatedCost\": 123,\n \"inputTokens\": 123,\n \"agentName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"recentToolCalls\": [\n {\n \"toolName\": \"<string>\",\n \"args\": \"<string>\"\n }\n ]\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/guardrails/check")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"My card number is 4111 1111 1111 1111.\",\n \"traceId\": \"<string>\",\n \"spanId\": \"<string>\",\n \"model\": \"gpt-4o\",\n \"operation\": \"<string>\",\n \"estimatedCost\": 123,\n \"inputTokens\": 123,\n \"agentName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"recentToolCalls\": [\n {\n \"toolName\": \"<string>\",\n \"args\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zespan.com/v1/guardrails/check")
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 \"text\": \"My card number is 4111 1111 1111 1111.\",\n \"traceId\": \"<string>\",\n \"spanId\": \"<string>\",\n \"model\": \"gpt-4o\",\n \"operation\": \"<string>\",\n \"estimatedCost\": 123,\n \"inputTokens\": 123,\n \"agentName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"recentToolCalls\": [\n {\n \"toolName\": \"<string>\",\n \"args\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"allowed": false,
"results": [
{
"guardrailSlug": "pii-detection",
"passed": false,
"reason": "Detected credit card number",
"modifiedText": "<string>",
"latencyMs": 12
}
],
"modifiedText": "My card number is [REDACTED]."
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}Run a guardrails check
Evaluate text against the authenticated project’s enabled guardrails at runtime. Returns whether the text is allowed, the per-guardrail results, and any modified (e.g. redacted) text. Requires x-api-key.
POST
/
v1
/
guardrails
/
check
Run a guardrails check
curl --request POST \
--url https://api.zespan.com/v1/guardrails/check \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"text": "My card number is 4111 1111 1111 1111.",
"traceId": "<string>",
"spanId": "<string>",
"model": "gpt-4o",
"operation": "<string>",
"estimatedCost": 123,
"inputTokens": 123,
"agentName": "<string>",
"toolName": "<string>",
"recentToolCalls": [
{
"toolName": "<string>",
"args": "<string>"
}
]
}
'import requests
url = "https://api.zespan.com/v1/guardrails/check"
payload = {
"text": "My card number is 4111 1111 1111 1111.",
"traceId": "<string>",
"spanId": "<string>",
"model": "gpt-4o",
"operation": "<string>",
"estimatedCost": 123,
"inputTokens": 123,
"agentName": "<string>",
"toolName": "<string>",
"recentToolCalls": [
{
"toolName": "<string>",
"args": "<string>"
}
]
}
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({
text: 'My card number is 4111 1111 1111 1111.',
traceId: '<string>',
spanId: '<string>',
model: 'gpt-4o',
operation: '<string>',
estimatedCost: 123,
inputTokens: 123,
agentName: '<string>',
toolName: '<string>',
recentToolCalls: [{toolName: '<string>', args: '<string>'}]
})
};
fetch('https://api.zespan.com/v1/guardrails/check', 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/guardrails/check",
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([
'text' => 'My card number is 4111 1111 1111 1111.',
'traceId' => '<string>',
'spanId' => '<string>',
'model' => 'gpt-4o',
'operation' => '<string>',
'estimatedCost' => 123,
'inputTokens' => 123,
'agentName' => '<string>',
'toolName' => '<string>',
'recentToolCalls' => [
[
'toolName' => '<string>',
'args' => '<string>'
]
]
]),
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/guardrails/check"
payload := strings.NewReader("{\n \"text\": \"My card number is 4111 1111 1111 1111.\",\n \"traceId\": \"<string>\",\n \"spanId\": \"<string>\",\n \"model\": \"gpt-4o\",\n \"operation\": \"<string>\",\n \"estimatedCost\": 123,\n \"inputTokens\": 123,\n \"agentName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"recentToolCalls\": [\n {\n \"toolName\": \"<string>\",\n \"args\": \"<string>\"\n }\n ]\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/guardrails/check")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"My card number is 4111 1111 1111 1111.\",\n \"traceId\": \"<string>\",\n \"spanId\": \"<string>\",\n \"model\": \"gpt-4o\",\n \"operation\": \"<string>\",\n \"estimatedCost\": 123,\n \"inputTokens\": 123,\n \"agentName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"recentToolCalls\": [\n {\n \"toolName\": \"<string>\",\n \"args\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zespan.com/v1/guardrails/check")
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 \"text\": \"My card number is 4111 1111 1111 1111.\",\n \"traceId\": \"<string>\",\n \"spanId\": \"<string>\",\n \"model\": \"gpt-4o\",\n \"operation\": \"<string>\",\n \"estimatedCost\": 123,\n \"inputTokens\": 123,\n \"agentName\": \"<string>\",\n \"toolName\": \"<string>\",\n \"recentToolCalls\": [\n {\n \"toolName\": \"<string>\",\n \"args\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"allowed": false,
"results": [
{
"guardrailSlug": "pii-detection",
"passed": false,
"reason": "Detected credit card number",
"modifiedText": "<string>",
"latencyMs": 12
}
],
"modifiedText": "My card number is [REDACTED]."
}{
"error": "Unauthorized",
"code": "rate_limit_exceeded"
}Authorizations
Project API key. Manage keys in the Zespan dashboard under project settings.
Body
application/json
Required string length:
1 - 50000Example:
"My card number is 4111 1111 1111 1111."
Whether this is checking input (pre) or output (post).
Available options:
pre, post Example:
"gpt-4o"
Maximum string length:
200Maximum string length:
200Maximum array length:
100Show child attributes
Show child attributes
Was this page helpful?
⌘I

