Skip to main content
POST
/
toxicity-meter
/
Get Toxicity
curl --request POST \
  --url https://rai-prod.studio.lyzr.ai/toxicity-meter/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "input_text": "What the fuck!",
  "agent_id": "67e3aff94c4db47d2999cdef",
  "session_id": "67e3aff94c4db47d2999cdef-g6bayx8ijn",
  "run_id": "string"
}
'
import requests

url = "https://rai-prod.studio.lyzr.ai/toxicity-meter/"

payload = {
    "input_text": "What the fuck!",
    "agent_id": "67e3aff94c4db47d2999cdef",
    "session_id": "67e3aff94c4db47d2999cdef-g6bayx8ijn",
    "run_id": "string"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input_text: 'What the fuck!',
    agent_id: '67e3aff94c4db47d2999cdef',
    session_id: '67e3aff94c4db47d2999cdef-g6bayx8ijn',
    run_id: 'string'
  })
};

fetch('https://rai-prod.studio.lyzr.ai/toxicity-meter/', 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/toxicity-meter/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input_text' => 'What the fuck!',
    'agent_id' => '67e3aff94c4db47d2999cdef',
    'session_id' => '67e3aff94c4db47d2999cdef-g6bayx8ijn',
    'run_id' => 'string'
  ]),
  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://rai-prod.studio.lyzr.ai/toxicity-meter/"

	payload := strings.NewReader("{\n  \"input_text\": \"What the fuck!\",\n  \"agent_id\": \"67e3aff94c4db47d2999cdef\",\n  \"session_id\": \"67e3aff94c4db47d2999cdef-g6bayx8ijn\",\n  \"run_id\": \"string\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://rai-prod.studio.lyzr.ai/toxicity-meter/")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input_text\": \"What the fuck!\",\n  \"agent_id\": \"67e3aff94c4db47d2999cdef\",\n  \"session_id\": \"67e3aff94c4db47d2999cdef-g6bayx8ijn\",\n  \"run_id\": \"string\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input_text\": \"What the fuck!\",\n  \"agent_id\": \"67e3aff94c4db47d2999cdef\",\n  \"session_id\": \"67e3aff94c4db47d2999cdef-g6bayx8ijn\",\n  \"run_id\": \"string\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "TOXIC",
  "details": {
    "is_toxic": true,
    "confidence": 99.9
  },
  "status_code": 200
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Endpoint

POST /toxicity-meter/

Base URL

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

Authentication

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

Request Body

FieldTypeRequiredDescription
input_textstringYesThe text to analyze for toxicity.
agent_idstringYesThe associated agent’s unique ID.
session_idstringYesThe current session’s unique ID.
run_idstringNoOptional run ID for traceability.

Example Request Body

{
  "input_text": "What the hell!"
  "agent_id": "67e3aff94c4db47d2999cdef",
  "session_id": "67e3aff94c4db47d2999cdef-g6bayx8ijn",
  "run_id": "string"
}

Authorizations

x-api-key
string
header
required

Body

application/json
input_text
string
required
Example:

"What the fuck!"

agent_id
string
required
Example:

"67e3aff94c4db47d2999cdef"

session_id
string
required
Example:

"67e3aff94c4db47d2999cdef-g6bayx8ijn"

run_id
string
Example:

"string"

Response

Successful toxicity check

message
string
Example:

"TOXIC"

details
object
status_code
integer
Example:

200