Skip to main content
POST
/
v2
/
guardrail-rules
Create guardrail rule
curl --request POST \
  --url https://api.orq.ai/v2/guardrail-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "enabled": true,
  "guardrails": [
    {
      "id": "<string>",
      "is_guardrail": true,
      "options": {},
      "sample_rate": 0.5
    }
  ],
  "project_id": "<string>",
  "timeout": 1001
}
'
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    description: '<string>',
    enabled: true,
    guardrails: [{id: '<string>', is_guardrail: true, options: {}, sample_rate: 0.5}],
    project_id: '<string>',
    timeout: 1001
  })
};

fetch('https://api.orq.ai/v2/guardrail-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://api.orq.ai/v2/guardrail-rules"

payload = {
    "display_name": "<string>",
    "description": "<string>",
    "enabled": True,
    "guardrails": [
        {
            "id": "<string>",
            "is_guardrail": True,
            "options": {},
            "sample_rate": 0.5
        }
    ],
    "project_id": "<string>",
    "timeout": 1001
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_id": "<string>",
  "display_name": "<string>",
  "enabled": true,
  "project_id": "<string>",
  "timeout": 1001,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by_id": "<string>",
  "description": "<string>",
  "expression": {
    "cel": "<string>",
    "config": {}
  },
  "guardrails": [
    {
      "id": "<string>",
      "is_guardrail": true,
      "options": {},
      "sample_rate": 0.5
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
display_name
string
required
Required string length: 1 - 256
​
description
string
Maximum string length: 2048
​
enabled
boolean
​
expression
object
​
guardrails
object[] | null
​
project_id
string

Optional project ID. If null/omitted, the entity is global (workspace-wide).

​
timeout
integer<int64>
Required range: x >= 1000

Response

Guardrail rule created successfully

​
_id
string
required
​
created_at
string<date-time>
required
​
created_by_id
string
required
​
display_name
string
required
Required string length: 1 - 256
​
enabled
boolean
required
​
project_id
string
required
​
timeout
integer<int64>
required
Required range: x >= 1000
​
updated_at
string<date-time>
required
​
updated_by_id
string
required
​
description
string
Maximum string length: 2048
​
expression
object
​
guardrails
object[] | null