Skip to main content
PUT
/
applications
/
{applicationId}
/
guardrails
Configure guardrails
curl --request PUT \
  --url https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --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"
        ],
        "threshold": 0.5
      }
    }
  ]
}
'
import requests

url = "https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails"

payload = {
"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"],
"threshold": 0.5
}
}
]
}
headers = {
"x-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-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'], threshold: 0.5}
}
]
})
};

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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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'
],
'threshold' => 0.5
]
]
]
]),
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://backend.trusys.ai/api/external/applications/{applicationId}/guardrails"

payload := strings.NewReader("{\n \"enable_guard_rails\": true,\n \"input_validators\": [\n {\n \"type\": \"prompt-injection\",\n \"on_fail\": \"fail\",\n \"config\": {\n \"threshold\": 0.8\n }\n }\n ],\n \"output_validators\": [\n {\n \"type\": \"pii\",\n \"on_fail\": \"mask\",\n \"config\": {\n \"entities\": [\n \"EMAIL_ADDRESS\"\n ],\n \"threshold\": 0.5\n }\n }\n ]\n}")

req, _ := http.NewRequest("PUT", 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.put("https://backend.trusys.ai/api/external/applications/{applicationId}/guardrails")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enable_guard_rails\": true,\n \"input_validators\": [\n {\n \"type\": \"prompt-injection\",\n \"on_fail\": \"fail\",\n \"config\": {\n \"threshold\": 0.8\n }\n }\n ],\n \"output_validators\": [\n {\n \"type\": \"pii\",\n \"on_fail\": \"mask\",\n \"config\": {\n \"entities\": [\n \"EMAIL_ADDRESS\"\n ],\n \"threshold\": 0.5\n }\n }\n ]\n}")
.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::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enable_guard_rails\": true,\n \"input_validators\": [\n {\n \"type\": \"prompt-injection\",\n \"on_fail\": \"fail\",\n \"config\": {\n \"threshold\": 0.8\n }\n }\n ],\n \"output_validators\": [\n {\n \"type\": \"pii\",\n \"on_fail\": \"mask\",\n \"config\": {\n \"entities\": [\n \"EMAIL_ADDRESS\"\n ],\n \"threshold\": 0.5\n }\n }\n ]\n}"

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": "prompt-injection",
        "on_fail": "fail",
        "config": {
          "threshold": 0.8
        }
      }
    ]
  }
}
{
"success": false,
"message": "Invalid request body",
"errors": [
{
"path": "name",
"message": "name is required"
}
]
}
{
"message": "Error while verifying api key"
}
{
"success": false,
"message": "Application not found"
}

Authorizations

x-api-key
string
header
required

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

applicationId
string<uuid>
required

Unique identifier (UUID) of the application. Returned by POST /applications.

Body

application/json

Guardrails toggle and validator lists.

enable_guard_rails
boolean
required

Master switch for guardrails on this application.

input_validators
object[]

Validators applied to user/model input. Each item is an object with type, on_fail, and optional config.

output_validators
object[]

Validators applied to model output. Each item is an object with type, on_fail, and optional config.

Response

Guardrails configuration saved.

success
boolean
data
object

Guardrails validators applied to application input and output.