Skip to main content
GET
/
v1
/
rai
/
policies
Get Policies By User
curl --request GET \
  --url https://rai-prod.studio.lyzr.ai/v1/rai/policies \
  --header 'x-api-key: <api-key>'
import requests

url = "https://rai-prod.studio.lyzr.ai/v1/rai/policies"

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://rai-prod.studio.lyzr.ai/v1/rai/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://rai-prod.studio.lyzr.ai/v1/rai/policies",
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://rai-prod.studio.lyzr.ai/v1/rai/policies"

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://rai-prod.studio.lyzr.ai/v1/rai/policies")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://rai-prod.studio.lyzr.ai/v1/rai/policies")

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
{
  "policies": [
    {
      "_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "allowed_topics": {
        "enabled": true,
        "topics": [
          "<string>"
        ]
      },
      "banned_topics": {
        "enabled": true,
        "topics": [
          "<string>"
        ]
      },
      "keywords": {
        "enabled": true,
        "keywords": [
          "<string>"
        ]
      },
      "toxicity_check": {
        "enabled": true,
        "threshold": 123
      },
      "prompt_injection": {
        "enabled": true,
        "threshold": 123
      },
      "secrets_detection": {
        "enabled": true,
        "action": "<string>"
      },
      "pii_detection": {
        "enabled": true,
        "types": {},
        "custom_pii": [
          "<string>"
        ]
      },
      "user_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Endpoint

GET /v1/rai/policies

Description

Fetches all RAI policies for the authenticated user.

Base URL

https://rai-prod.studio.lyzr.ai

Authentication

API Key (x-api-key) must be included in the header.

Curl Request

curl -X GET "https://rai-prod.studio.lyzr.ai/v1/rai/policies" \
-H "accept: application/json" \
-H "x-api-key: sk-default-REDACTED"

Authorizations

x-api-key
string
header
required

Response

Successful Response

policies
object[]