List guardrail rules - Orq.ai Documentation

GET

guardrail-rules

List guardrail rules

curl --request GET \
  --url https://api.orq.ai/v2/guardrail-rules \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": [
    {
      "_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
        }
      ]
    }
  ],
  "has_more": true,
  "object": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer<int64>

default:10

Required range: 1 <= x <= 200

starting_after

string

A cursor for use in pagination.

ending_before

string

A cursor for use in pagination.

project_id

string

Optional filter by project ID.

string

Filter by display name or description (case-insensitive).

sort_by

enum<string>

Field to sort by. Defaults to created_at (newest first).

Available options:

created_at,

updated_at,

display_name

enabled

boolean | null

Filter by enabled status.

guardrail_id

string[] | null

Filter by referenced guardrail ids (comma-separated).

Response

200 - application/json

Guardrail rules retrieved successfully

data

object[] | null

required

Show child attributes

has_more

boolean

required

object

string

required

List Guardrail versions

Create guardrail rule

⌘I

List guardrail rules

curl --request GET \
  --url https://api.orq.ai/v2/guardrail-rules \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": [
    {
      "_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
        }
      ]
    }
  ],
  "has_more": true,
  "object": "<string>"
}