Set Conversation Security Analyzer
curl --request POST \
--url https://api.example.com/api/conversations/{conversation_id}/security_analyzer \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"security_analyzer": {
"high_patterns": [
[
"<string>",
"<string>",
"<string>"
]
],
"injection_high_patterns": [
[
"<string>",
"<string>",
"<string>"
]
],
"injection_medium_patterns": [
[
"<string>",
"<string>",
"<string>"
]
],
"kind": "PatternSecurityAnalyzer",
"medium_patterns": [
[
"<string>",
"<string>",
"<string>"
]
]
}
}
'import requests
url = "https://api.example.com/api/conversations/{conversation_id}/security_analyzer"
payload = { "security_analyzer": {
"high_patterns": [["<string>", "<string>", "<string>"]],
"injection_high_patterns": [["<string>", "<string>", "<string>"]],
"injection_medium_patterns": [["<string>", "<string>", "<string>"]],
"kind": "PatternSecurityAnalyzer",
"medium_patterns": [["<string>", "<string>", "<string>"]]
} }
headers = {
"X-Session-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-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
security_analyzer: {
high_patterns: [['<string>', '<string>', '<string>']],
injection_high_patterns: [['<string>', '<string>', '<string>']],
injection_medium_patterns: [['<string>', '<string>', '<string>']],
kind: 'PatternSecurityAnalyzer',
medium_patterns: [['<string>', '<string>', '<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' => [
'high_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
],
'injection_high_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
],
'injection_medium_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
],
'kind' => 'PatternSecurityAnalyzer',
'medium_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Session-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://api.example.com/api/conversations/{conversation_id}/security_analyzer"
payload := strings.NewReader("{\n \"security_analyzer\": {\n \"high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"kind\": \"PatternSecurityAnalyzer\",\n \"medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-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://api.example.com/api/conversations/{conversation_id}/security_analyzer")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"security_analyzer\": {\n \"high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"kind\": \"PatternSecurityAnalyzer\",\n \"medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ]\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["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"security_analyzer\": {\n \"high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"kind\": \"PatternSecurityAnalyzer\",\n \"medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Conversations
Set Conversation Security Analyzer
Set the security analyzer for a conversation.
POST
/
api
/
conversations
/
{conversation_id}
/
security_analyzer
Set Conversation Security Analyzer
curl --request POST \
--url https://api.example.com/api/conversations/{conversation_id}/security_analyzer \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"security_analyzer": {
"high_patterns": [
[
"<string>",
"<string>",
"<string>"
]
],
"injection_high_patterns": [
[
"<string>",
"<string>",
"<string>"
]
],
"injection_medium_patterns": [
[
"<string>",
"<string>",
"<string>"
]
],
"kind": "PatternSecurityAnalyzer",
"medium_patterns": [
[
"<string>",
"<string>",
"<string>"
]
]
}
}
'import requests
url = "https://api.example.com/api/conversations/{conversation_id}/security_analyzer"
payload = { "security_analyzer": {
"high_patterns": [["<string>", "<string>", "<string>"]],
"injection_high_patterns": [["<string>", "<string>", "<string>"]],
"injection_medium_patterns": [["<string>", "<string>", "<string>"]],
"kind": "PatternSecurityAnalyzer",
"medium_patterns": [["<string>", "<string>", "<string>"]]
} }
headers = {
"X-Session-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-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
security_analyzer: {
high_patterns: [['<string>', '<string>', '<string>']],
injection_high_patterns: [['<string>', '<string>', '<string>']],
injection_medium_patterns: [['<string>', '<string>', '<string>']],
kind: 'PatternSecurityAnalyzer',
medium_patterns: [['<string>', '<string>', '<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' => [
'high_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
],
'injection_high_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
],
'injection_medium_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
],
'kind' => 'PatternSecurityAnalyzer',
'medium_patterns' => [
[
'<string>',
'<string>',
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Session-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://api.example.com/api/conversations/{conversation_id}/security_analyzer"
payload := strings.NewReader("{\n \"security_analyzer\": {\n \"high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"kind\": \"PatternSecurityAnalyzer\",\n \"medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-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://api.example.com/api/conversations/{conversation_id}/security_analyzer")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"security_analyzer\": {\n \"high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"kind\": \"PatternSecurityAnalyzer\",\n \"medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ]\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["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"security_analyzer\": {\n \"high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_high_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"injection_medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ],\n \"kind\": \"PatternSecurityAnalyzer\",\n \"medium_patterns\": [\n [\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ]\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Path Parameters
Body
application/json
Payload to set security analyzer for a conversation
The security analyzer to set
- PatternSecurityAnalyzer
- PolicyRailSecurityAnalyzer
- EnsembleSecurityAnalyzer
- GraySwanAnalyzer
- LLMSecurityAnalyzer
- ToolShieldLLMSecurityAnalyzer
Show child attributes
Show child attributes
Response
Successful Response
Was this page helpful?