Set Conversation Security Analyzer

Set the security analyzer for a conversation.

POST /api/conversations/{conversation_id}/security_analyzer

Set Conversation Security Analyzer

cURL

curl --request POST \
  --url https://api.example.com/api/conversations/{conversation_id}/security_analyzer \
  --header 'Content-Type: application/json' \
  --data '
{
  "security_analyzer": {
    "history_limit": 20,
    "max_message_chars": 30000,
    "timeout": 30,
    "low_threshold": 0.3,
    "medium_threshold": 0.7,
    "api_url": "https://api.grayswan.ai/cygnal/monitor",
    "api_key": "<string>",
    "policy_id": "<string>",
    "kind": "<string>"
  }
}
'

import requests

url = "https://api.example.com/api/conversations/{conversation_id}/security_analyzer"

payload = { "security_analyzer": {
        "history_limit": 20,
        "max_message_chars": 30000,
        "timeout": 30,
        "low_threshold": 0.3,
        "medium_threshold": 0.7,
        "api_url": "https://api.grayswan.ai/cygnal/monitor",
        "api_key": "<string>",
        "policy_id": "<string>",
        "kind": "<string>"
    } }
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    security_analyzer: {
      history_limit: 20,
      max_message_chars: 30000,
      timeout: 30,
      low_threshold: 0.3,
      medium_threshold: 0.7,
      api_url: 'https://api.grayswan.ai/cygnal/monitor',
      api_key: '<string>',
      policy_id: '<string>',
      kind: '<string>'
    }
  })
};

fetch('https://api.example.com/api/conversations/{conversation_id}/security_analyzer', 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://api.example.com/api/conversations/{conversation_id}/security_analyzer",
  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([
    'security_analyzer' => [
        'history_limit' => 20,
        'max_message_chars' => 30000,
        'timeout' => 30,
        'low_threshold' => 0.3,
        'medium_threshold' => 0.7,
        'api_url' => 'https://api.grayswan.ai/cygnal/monitor',
        'api_key' => '<string>',
        'policy_id' => '<string>',
        'kind' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/api/conversations/{conversation_id}/security_analyzer"

	payload := strings.NewReader("{\n  \"security_analyzer\": {\n    \"history_limit\": 20,\n    \"max_message_chars\": 30000,\n    \"timeout\": 30,\n    \"low_threshold\": 0.3,\n    \"medium_threshold\": 0.7,\n    \"api_url\": \"https://api.grayswan.ai/cygnal/monitor\",\n    \"api_key\": \"<string>\",\n    \"policy_id\": \"<string>\",\n    \"kind\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.example.com/api/conversations/{conversation_id}/security_analyzer")
  .header("Content-Type", "application/json")
  .body("{\n  \"security_analyzer\": {\n    \"history_limit\": 20,\n    \"max_message_chars\": 30000,\n    \"timeout\": 30,\n    \"low_threshold\": 0.3,\n    \"medium_threshold\": 0.7,\n    \"api_url\": \"https://api.grayswan.ai/cygnal/monitor\",\n    \"api_key\": \"<string>\",\n    \"policy_id\": \"<string>\",\n    \"kind\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/conversations/{conversation_id}/security_analyzer")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"security_analyzer\": {\n    \"history_limit\": 20,\n    \"max_message_chars\": 30000,\n    \"timeout\": 30,\n    \"low_threshold\": 0.3,\n    \"medium_threshold\": 0.7,\n    \"api_url\": \"https://api.grayswan.ai/cygnal/monitor\",\n    \"api_key\": \"<string>\",\n    \"policy_id\": \"<string>\",\n    \"kind\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

conversation_id · string<uuid> · required

Body

application/json

Payload to set security analyzer for a conversation

security_analyzer · GraySwanAnalyzer · object · required

The security analyzer to set

GraySwanAnalyzer

LLMSecurityAnalyzer

Show child attributes

Response

200

application/json

Successful Response

success · boolean · default: true