护栏
创建护栏策略
创建一个新的护栏策略。
POST
/
api
/
v1
/
guardrail-policies
创建护栏策略
curl --request POST \
--url https://api.example.com/api/v1/guardrail-policies \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"rules": [
{}
],
"scope": "<string>",
"is_default": true
}
'import requests
url = "https://api.example.com/api/v1/guardrail-policies"
payload = {
"name": "<string>",
"description": "<string>",
"rules": [{}],
"scope": "<string>",
"is_default": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
rules: [{}],
scope: '<string>',
is_default: true
})
};
fetch('https://api.example.com/api/v1/guardrail-policies', 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.example.com/api/v1/guardrail-policies",
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>',
'description' => '<string>',
'rules' => [
[
]
],
'scope' => '<string>',
'is_default' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/v1/guardrail-policies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": [\n {}\n ],\n \"scope\": \"<string>\",\n \"is_default\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/guardrail-policies")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": [\n {}\n ],\n \"scope\": \"<string>\",\n \"is_default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/guardrail-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": [\n {}\n ],\n \"scope\": \"<string>\",\n \"is_default\": true\n}"
response = http.request(request)
puts response.read_body创建一个新的护栏策略。此操作具有幂等性——使用相同的
Idempotency-Key 请求头会重放相同的响应。
创建策略不会自动将其绑定到某个密钥。请使用 PUT /api/v1/keys//guardrails 为某个密钥启用该策略。
身份验证
需要携带具有billing API 密钥作用域的 Bearer 令牌。
请求体
string
必填
策略名称。1–128 个字符。不得引用上游供应商名称。
string
自由文本描述。最多 512 个字符。
object[]
最多 32 个规则对象。每条规则包含
guardrail_id、phase、verdict，以及可选的 config 配置包。string
"personal"（默认）或 "team"。团队作用域需要一个活跃的组织以及 manageWebhooks 权限。boolean
将此策略标记为其所在作用域的默认策略。每个作用域最多只能有一个默认策略。
请求示例
curl -X POST https://www.hitheo.ai/api/v1/guardrail-policies \
-H "Authorization: Bearer $THEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Compliance-strict",
"description": "PII redaction + jailbreak deny.",
"rules": [
{ "guardrail_id": "pii_redactor", "phase": "input", "verdict": "redact" },
{ "guardrail_id": "prompt_injection", "phase": "input", "verdict": "deny" }
]
}'
const policy = await theo.guardrails.policies.create({
name: "Compliance-strict",
description: "PII redaction + jailbreak deny.",
rules: [
{ guardrail_id: "pii_redactor", phase: "input", verdict: "redact" },
{ guardrail_id: "prompt_injection", phase: "input", verdict: "deny" },
],
});
错误
400 guardrail_policy_invalid— 护栏 id 未知、内置护栏使用了不允许的判定结果、标签中包含供应商名称，或规则数量超出上限。403 missing_scope— API 密钥缺少billing作用域。409 conflict— 该作用域下已存在设置为is_default: true的策略。
此页面对您有帮助吗？
创建护栏策略
curl --request POST \
--url https://api.example.com/api/v1/guardrail-policies \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"rules": [
{}
],
"scope": "<string>",
"is_default": true
}
'import requests
url = "https://api.example.com/api/v1/guardrail-policies"
payload = {
"name": "<string>",
"description": "<string>",
"rules": [{}],
"scope": "<string>",
"is_default": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
rules: [{}],
scope: '<string>',
is_default: true
})
};
fetch('https://api.example.com/api/v1/guardrail-policies', 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.example.com/api/v1/guardrail-policies",
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>',
'description' => '<string>',
'rules' => [
[
]
],
'scope' => '<string>',
'is_default' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/v1/guardrail-policies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": [\n {}\n ],\n \"scope\": \"<string>\",\n \"is_default\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/guardrail-policies")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": [\n {}\n ],\n \"scope\": \"<string>\",\n \"is_default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/guardrail-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"rules\": [\n {}\n ],\n \"scope\": \"<string>\",\n \"is_default\": true\n}"
response = http.request(request)
puts response.read_body