Get guardrails configuration
curl --request GET \
--url https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails \
--header 'x-api-key: <api-key>'import requests
url = "https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails', 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://backend.trusys.ai/api/external/applications/{applicationId}/guardrails",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enable_guard_rails": true,
"input_validators": [
{
"type": "prompt-injection",
"on_fail": "fail",
"config": {
"threshold": 0.8
}
}
],
"output_validators": [
{
"type": "pii",
"on_fail": "mask",
"config": {
"entities": [
"EMAIL_ADDRESS",
"PHONE_NUMBER"
],
"threshold": 0.5
}
}
]
}
}{
"message": "Error while verifying api key"
}{
"success": false,
"message": "Application not found"
}Get guardrails configuration
Returns the guardrails enabled for an application.
input_validators and output_validators are arrays of objects (not maps). Each object has:
type— validator id fromGET /guardrails/validators(for exampleprompt-injection,pii)on_fail— enforcement action when validation fails (for examplefail,mask,filter)config— optional validator-specific settings (shape varies bytype; see the catalogconfigtemplate)
GET
/
applications
/
{applicationId}
/
guardrails
Get guardrails configuration
curl --request GET \
--url https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails \
--header 'x-api-key: <api-key>'import requests
url = "https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails', 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://backend.trusys.ai/api/external/applications/{applicationId}/guardrails",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enable_guard_rails": true,
"input_validators": [
{
"type": "prompt-injection",
"on_fail": "fail",
"config": {
"threshold": 0.8
}
}
],
"output_validators": [
{
"type": "pii",
"on_fail": "mask",
"config": {
"entities": [
"EMAIL_ADDRESS",
"PHONE_NUMBER"
],
"threshold": 0.5
}
}
]
}
}{
"message": "Error while verifying api key"
}{
"success": false,
"message": "Application not found"
}Authorizations
Your Trusys API key. Create and manage keys in the Trusys UI under Settings → API Keys.
Include the key on every request:
x-api-key: <your-api-key>
Path Parameters
Unique identifier (UUID) of the application. Returned by POST /applications.