Run Redteam
curl --request POST \
--url https://api.enkryptai.com/rt/redteam \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"target": {
"endpoint": "<string>",
"api_key": "<string>",
"model_name": "<string>",
"provider": "<string>",
"system_prompt": "<string>",
"system_type": "foundation_model",
"input_modalities": [],
"output_modalities": [],
"tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"connect_via_relay": true,
"metadata": {
"relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": {
"Authorization": "Bearer customer-side-internal-key"
}
}
},
"relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": {
"Authorization": "Bearer customer-side-internal-key"
}
}
},
"risk_categories": {},
"compliance_frameworks": [],
"context": {
"system_description": "<string>",
"policy_description": "<string>",
"policy_rules": [
{
"id": "<string>",
"text": "<string>",
"risk_category": "<string>",
"severity": "<string>",
"frameworks": [
"<string>"
]
}
]
},
"generation_config": {
"dataset_name": "<string>",
"max_prompts": 250,
"seed_prompts": [
{
"prompt": "<string>"
}
],
"include_standard_library": true
},
"run_name": "<string>",
"comprehensiveness": "Standard",
"user_metadata": {}
}
'import requests
url = "https://api.enkryptai.com/rt/redteam"
payload = {
"target": {
"endpoint": "<string>",
"api_key": "<string>",
"model_name": "<string>",
"provider": "<string>",
"system_prompt": "<string>",
"system_type": "foundation_model",
"input_modalities": [],
"output_modalities": [],
"tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"connect_via_relay": True,
"metadata": { "relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": { "Authorization": "Bearer customer-side-internal-key" }
} },
"relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": { "Authorization": "Bearer customer-side-internal-key" }
}
},
"risk_categories": {},
"compliance_frameworks": [],
"context": {
"system_description": "<string>",
"policy_description": "<string>",
"policy_rules": [
{
"id": "<string>",
"text": "<string>",
"risk_category": "<string>",
"severity": "<string>",
"frameworks": ["<string>"]
}
]
},
"generation_config": {
"dataset_name": "<string>",
"max_prompts": 250,
"seed_prompts": [{ "prompt": "<string>" }],
"include_standard_library": True
},
"run_name": "<string>",
"comprehensiveness": "Standard",
"user_metadata": {}
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: {
endpoint: '<string>',
api_key: '<string>',
model_name: '<string>',
provider: '<string>',
system_prompt: '<string>',
system_type: 'foundation_model',
input_modalities: [],
output_modalities: [],
tools: [{name: '<string>', description: '<string>', parameters: {}}],
connect_via_relay: true,
metadata: {
relay: {
bridge_id: 'customer-bridge-1',
target_endpoint: 'https://customer-internal-llm.local/v1/chat/completions',
model_name: 'their-internal-model',
target_headers: {Authorization: 'Bearer customer-side-internal-key'}
}
},
relay: {
bridge_id: 'customer-bridge-1',
target_endpoint: 'https://customer-internal-llm.local/v1/chat/completions',
model_name: 'their-internal-model',
target_headers: {Authorization: 'Bearer customer-side-internal-key'}
}
},
risk_categories: {},
compliance_frameworks: [],
context: {
system_description: '<string>',
policy_description: '<string>',
policy_rules: [
{
id: '<string>',
text: '<string>',
risk_category: '<string>',
severity: '<string>',
frameworks: ['<string>']
}
]
},
generation_config: {
dataset_name: '<string>',
max_prompts: 250,
seed_prompts: [{prompt: '<string>'}],
include_standard_library: true
},
run_name: '<string>',
comprehensiveness: 'Standard',
user_metadata: {}
})
};
fetch('https://api.enkryptai.com/rt/redteam', 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.enkryptai.com/rt/redteam",
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([
'target' => [
'endpoint' => '<string>',
'api_key' => '<string>',
'model_name' => '<string>',
'provider' => '<string>',
'system_prompt' => '<string>',
'system_type' => 'foundation_model',
'input_modalities' => [
],
'output_modalities' => [
],
'tools' => [
[
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
],
'connect_via_relay' => true,
'metadata' => [
'relay' => [
'bridge_id' => 'customer-bridge-1',
'target_endpoint' => 'https://customer-internal-llm.local/v1/chat/completions',
'model_name' => 'their-internal-model',
'target_headers' => [
'Authorization' => 'Bearer customer-side-internal-key'
]
]
],
'relay' => [
'bridge_id' => 'customer-bridge-1',
'target_endpoint' => 'https://customer-internal-llm.local/v1/chat/completions',
'model_name' => 'their-internal-model',
'target_headers' => [
'Authorization' => 'Bearer customer-side-internal-key'
]
]
],
'risk_categories' => [
],
'compliance_frameworks' => [
],
'context' => [
'system_description' => '<string>',
'policy_description' => '<string>',
'policy_rules' => [
[
'id' => '<string>',
'text' => '<string>',
'risk_category' => '<string>',
'severity' => '<string>',
'frameworks' => [
'<string>'
]
]
]
],
'generation_config' => [
'dataset_name' => '<string>',
'max_prompts' => 250,
'seed_prompts' => [
[
'prompt' => '<string>'
]
],
'include_standard_library' => true
],
'run_name' => '<string>',
'comprehensiveness' => 'Standard',
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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.enkryptai.com/rt/redteam"
payload := strings.NewReader("{\n \"target\": {\n \"endpoint\": \"<string>\",\n \"api_key\": \"<string>\",\n \"model_name\": \"<string>\",\n \"provider\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"system_type\": \"foundation_model\",\n \"input_modalities\": [],\n \"output_modalities\": [],\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"connect_via_relay\": true,\n \"metadata\": {\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"risk_categories\": {},\n \"compliance_frameworks\": [],\n \"context\": {\n \"system_description\": \"<string>\",\n \"policy_description\": \"<string>\",\n \"policy_rules\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"risk_category\": \"<string>\",\n \"severity\": \"<string>\",\n \"frameworks\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"generation_config\": {\n \"dataset_name\": \"<string>\",\n \"max_prompts\": 250,\n \"seed_prompts\": [\n {\n \"prompt\": \"<string>\"\n }\n ],\n \"include_standard_library\": true\n },\n \"run_name\": \"<string>\",\n \"comprehensiveness\": \"Standard\",\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<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.enkryptai.com/rt/redteam")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target\": {\n \"endpoint\": \"<string>\",\n \"api_key\": \"<string>\",\n \"model_name\": \"<string>\",\n \"provider\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"system_type\": \"foundation_model\",\n \"input_modalities\": [],\n \"output_modalities\": [],\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"connect_via_relay\": true,\n \"metadata\": {\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"risk_categories\": {},\n \"compliance_frameworks\": [],\n \"context\": {\n \"system_description\": \"<string>\",\n \"policy_description\": \"<string>\",\n \"policy_rules\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"risk_category\": \"<string>\",\n \"severity\": \"<string>\",\n \"frameworks\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"generation_config\": {\n \"dataset_name\": \"<string>\",\n \"max_prompts\": 250,\n \"seed_prompts\": [\n {\n \"prompt\": \"<string>\"\n }\n ],\n \"include_standard_library\": true\n },\n \"run_name\": \"<string>\",\n \"comprehensiveness\": \"Standard\",\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enkryptai.com/rt/redteam")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": {\n \"endpoint\": \"<string>\",\n \"api_key\": \"<string>\",\n \"model_name\": \"<string>\",\n \"provider\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"system_type\": \"foundation_model\",\n \"input_modalities\": [],\n \"output_modalities\": [],\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"connect_via_relay\": true,\n \"metadata\": {\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"risk_categories\": {},\n \"compliance_frameworks\": [],\n \"context\": {\n \"system_description\": \"<string>\",\n \"policy_description\": \"<string>\",\n \"policy_rules\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"risk_category\": \"<string>\",\n \"severity\": \"<string>\",\n \"frameworks\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"generation_config\": {\n \"dataset_name\": \"<string>\",\n \"max_prompts\": 250,\n \"seed_prompts\": [\n {\n \"prompt\": \"<string>\"\n }\n ],\n \"include_standard_library\": true\n },\n \"run_name\": \"<string>\",\n \"comprehensiveness\": \"Standard\",\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}🔴 Red Team API
Run Redteam
POST
/
rt
/
redteam
Run Redteam
curl --request POST \
--url https://api.enkryptai.com/rt/redteam \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"target": {
"endpoint": "<string>",
"api_key": "<string>",
"model_name": "<string>",
"provider": "<string>",
"system_prompt": "<string>",
"system_type": "foundation_model",
"input_modalities": [],
"output_modalities": [],
"tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"connect_via_relay": true,
"metadata": {
"relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": {
"Authorization": "Bearer customer-side-internal-key"
}
}
},
"relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": {
"Authorization": "Bearer customer-side-internal-key"
}
}
},
"risk_categories": {},
"compliance_frameworks": [],
"context": {
"system_description": "<string>",
"policy_description": "<string>",
"policy_rules": [
{
"id": "<string>",
"text": "<string>",
"risk_category": "<string>",
"severity": "<string>",
"frameworks": [
"<string>"
]
}
]
},
"generation_config": {
"dataset_name": "<string>",
"max_prompts": 250,
"seed_prompts": [
{
"prompt": "<string>"
}
],
"include_standard_library": true
},
"run_name": "<string>",
"comprehensiveness": "Standard",
"user_metadata": {}
}
'import requests
url = "https://api.enkryptai.com/rt/redteam"
payload = {
"target": {
"endpoint": "<string>",
"api_key": "<string>",
"model_name": "<string>",
"provider": "<string>",
"system_prompt": "<string>",
"system_type": "foundation_model",
"input_modalities": [],
"output_modalities": [],
"tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"connect_via_relay": True,
"metadata": { "relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": { "Authorization": "Bearer customer-side-internal-key" }
} },
"relay": {
"bridge_id": "customer-bridge-1",
"target_endpoint": "https://customer-internal-llm.local/v1/chat/completions",
"model_name": "their-internal-model",
"target_headers": { "Authorization": "Bearer customer-side-internal-key" }
}
},
"risk_categories": {},
"compliance_frameworks": [],
"context": {
"system_description": "<string>",
"policy_description": "<string>",
"policy_rules": [
{
"id": "<string>",
"text": "<string>",
"risk_category": "<string>",
"severity": "<string>",
"frameworks": ["<string>"]
}
]
},
"generation_config": {
"dataset_name": "<string>",
"max_prompts": 250,
"seed_prompts": [{ "prompt": "<string>" }],
"include_standard_library": True
},
"run_name": "<string>",
"comprehensiveness": "Standard",
"user_metadata": {}
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target: {
endpoint: '<string>',
api_key: '<string>',
model_name: '<string>',
provider: '<string>',
system_prompt: '<string>',
system_type: 'foundation_model',
input_modalities: [],
output_modalities: [],
tools: [{name: '<string>', description: '<string>', parameters: {}}],
connect_via_relay: true,
metadata: {
relay: {
bridge_id: 'customer-bridge-1',
target_endpoint: 'https://customer-internal-llm.local/v1/chat/completions',
model_name: 'their-internal-model',
target_headers: {Authorization: 'Bearer customer-side-internal-key'}
}
},
relay: {
bridge_id: 'customer-bridge-1',
target_endpoint: 'https://customer-internal-llm.local/v1/chat/completions',
model_name: 'their-internal-model',
target_headers: {Authorization: 'Bearer customer-side-internal-key'}
}
},
risk_categories: {},
compliance_frameworks: [],
context: {
system_description: '<string>',
policy_description: '<string>',
policy_rules: [
{
id: '<string>',
text: '<string>',
risk_category: '<string>',
severity: '<string>',
frameworks: ['<string>']
}
]
},
generation_config: {
dataset_name: '<string>',
max_prompts: 250,
seed_prompts: [{prompt: '<string>'}],
include_standard_library: true
},
run_name: '<string>',
comprehensiveness: 'Standard',
user_metadata: {}
})
};
fetch('https://api.enkryptai.com/rt/redteam', 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.enkryptai.com/rt/redteam",
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([
'target' => [
'endpoint' => '<string>',
'api_key' => '<string>',
'model_name' => '<string>',
'provider' => '<string>',
'system_prompt' => '<string>',
'system_type' => 'foundation_model',
'input_modalities' => [
],
'output_modalities' => [
],
'tools' => [
[
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
],
'connect_via_relay' => true,
'metadata' => [
'relay' => [
'bridge_id' => 'customer-bridge-1',
'target_endpoint' => 'https://customer-internal-llm.local/v1/chat/completions',
'model_name' => 'their-internal-model',
'target_headers' => [
'Authorization' => 'Bearer customer-side-internal-key'
]
]
],
'relay' => [
'bridge_id' => 'customer-bridge-1',
'target_endpoint' => 'https://customer-internal-llm.local/v1/chat/completions',
'model_name' => 'their-internal-model',
'target_headers' => [
'Authorization' => 'Bearer customer-side-internal-key'
]
]
],
'risk_categories' => [
],
'compliance_frameworks' => [
],
'context' => [
'system_description' => '<string>',
'policy_description' => '<string>',
'policy_rules' => [
[
'id' => '<string>',
'text' => '<string>',
'risk_category' => '<string>',
'severity' => '<string>',
'frameworks' => [
'<string>'
]
]
]
],
'generation_config' => [
'dataset_name' => '<string>',
'max_prompts' => 250,
'seed_prompts' => [
[
'prompt' => '<string>'
]
],
'include_standard_library' => true
],
'run_name' => '<string>',
'comprehensiveness' => 'Standard',
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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.enkryptai.com/rt/redteam"
payload := strings.NewReader("{\n \"target\": {\n \"endpoint\": \"<string>\",\n \"api_key\": \"<string>\",\n \"model_name\": \"<string>\",\n \"provider\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"system_type\": \"foundation_model\",\n \"input_modalities\": [],\n \"output_modalities\": [],\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"connect_via_relay\": true,\n \"metadata\": {\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"risk_categories\": {},\n \"compliance_frameworks\": [],\n \"context\": {\n \"system_description\": \"<string>\",\n \"policy_description\": \"<string>\",\n \"policy_rules\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"risk_category\": \"<string>\",\n \"severity\": \"<string>\",\n \"frameworks\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"generation_config\": {\n \"dataset_name\": \"<string>\",\n \"max_prompts\": 250,\n \"seed_prompts\": [\n {\n \"prompt\": \"<string>\"\n }\n ],\n \"include_standard_library\": true\n },\n \"run_name\": \"<string>\",\n \"comprehensiveness\": \"Standard\",\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<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.enkryptai.com/rt/redteam")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target\": {\n \"endpoint\": \"<string>\",\n \"api_key\": \"<string>\",\n \"model_name\": \"<string>\",\n \"provider\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"system_type\": \"foundation_model\",\n \"input_modalities\": [],\n \"output_modalities\": [],\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"connect_via_relay\": true,\n \"metadata\": {\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"risk_categories\": {},\n \"compliance_frameworks\": [],\n \"context\": {\n \"system_description\": \"<string>\",\n \"policy_description\": \"<string>\",\n \"policy_rules\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"risk_category\": \"<string>\",\n \"severity\": \"<string>\",\n \"frameworks\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"generation_config\": {\n \"dataset_name\": \"<string>\",\n \"max_prompts\": 250,\n \"seed_prompts\": [\n {\n \"prompt\": \"<string>\"\n }\n ],\n \"include_standard_library\": true\n },\n \"run_name\": \"<string>\",\n \"comprehensiveness\": \"Standard\",\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enkryptai.com/rt/redteam")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": {\n \"endpoint\": \"<string>\",\n \"api_key\": \"<string>\",\n \"model_name\": \"<string>\",\n \"provider\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"system_type\": \"foundation_model\",\n \"input_modalities\": [],\n \"output_modalities\": [],\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"connect_via_relay\": true,\n \"metadata\": {\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"relay\": {\n \"bridge_id\": \"customer-bridge-1\",\n \"target_endpoint\": \"https://customer-internal-llm.local/v1/chat/completions\",\n \"model_name\": \"their-internal-model\",\n \"target_headers\": {\n \"Authorization\": \"Bearer customer-side-internal-key\"\n }\n }\n },\n \"risk_categories\": {},\n \"compliance_frameworks\": [],\n \"context\": {\n \"system_description\": \"<string>\",\n \"policy_description\": \"<string>\",\n \"policy_rules\": [\n {\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"risk_category\": \"<string>\",\n \"severity\": \"<string>\",\n \"frameworks\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"generation_config\": {\n \"dataset_name\": \"<string>\",\n \"max_prompts\": 250,\n \"seed_prompts\": [\n {\n \"prompt\": \"<string>\"\n }\n ],\n \"include_standard_library\": true\n },\n \"run_name\": \"<string>\",\n \"comprehensiveness\": \"Standard\",\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Headers
Name of a saved Code of Conduct policy to test against. The gateway resolves it, renders its rules into context.policy_description (v1 free text, or the v2 Policy Wizard enabled rules joined in their stored order) and records the name on the run as policy_name. This OVERRIDES any context.policy_description sent in the body, so a run is never labelled with one policy but generated from another's text - omit the header to keep your own wording.
Example:
"customer-support-coc"
Body
application/json
POST /v1/redteam payload.
Per payload.md: model + (risk_categories | compliance_frameworks) + context
- generation_config.
attack_configlives nested under each risk_category. Optionalsub_categoriesphrases (from/threat-modeling/categories) may also nest under each risk_category to scope on-the-fly generation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
owasp_llm_top10, eu_ai_act, nist_ai_rmf, mitre_atlas, iso_42001, aiuc_1 Show child attributes
Show child attributes
generation_config block per payload.md.
Two mutually-exclusive modes:
- Pre-built dataset:
dataset_name - On-the-fly generation:
max_promptsand/orseed_prompts
Plus an orthogonal include_standard_library toggle (default true).
Show child attributes
Show child attributes
Required string length:
1 - 200How exhaustively to test. Standard runs the normal attack budget and Comprehensive widens it; Low, Medium and High are the equivalent sample-size settings surfaced in the dashboard. Omit to use the service default.
Available options:
Low, Medium, High, Standard, Comprehensive Example:
"Standard"
Response
Successful Response
The accepted run. run_id is the value to carry into the run endpoints (GET /rt/runs/{run_id}, /records, /results, /stream).
Do not follow the *_url fields verbatim. They are relative and are not guaranteed to carry the /rt/ prefix this API is published under, so requesting one as given can return 400. Build the URL from run_id and the paths documented here instead - /rt/runs/{run_id}/records is the resource you want. The same applies to records_url on the results payload.
websocket_url is the Server-Sent Events progress stream (/rt/runs/{run_id}/stream) despite its name. The live log socket is logs_url - a relative path to join onto wss://api.enkryptai.com/wss/redteam/v1/logs/tasks/. See the Stream Run Logs (WebSocket) endpoint.