Run a sample through the organization's live DLP pipeline
curl --request POST \
--url https://{host}/api/dlp/admin/v1/test/process-text \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plaintext": "<string>",
"runtime_stage": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"model_alias": "<string>",
"principal_ids": [
"<string>"
],
"provider_id": "<string>",
"provider_ids": [
"<string>"
]
},
"structured_payload_json": "<string>",
"tool_name": "<string>",
"user_groups": [
"<string>"
],
"user_roles": [
"<string>"
]
}
'import requests
url = "https://{host}/api/dlp/admin/v1/test/process-text"
payload = {
"plaintext": "<string>",
"runtime_stage": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"model_alias": "<string>",
"principal_ids": ["<string>"],
"provider_id": "<string>",
"provider_ids": ["<string>"]
},
"structured_payload_json": "<string>",
"tool_name": "<string>",
"user_groups": ["<string>"],
"user_roles": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plaintext: '<string>',
runtime_stage: '<string>',
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: {
model_alias: '<string>',
principal_ids: ['<string>'],
provider_id: '<string>',
provider_ids: ['<string>']
},
structured_payload_json: '<string>',
tool_name: '<string>',
user_groups: ['<string>'],
user_roles: ['<string>']
})
};
fetch('https://{host}/api/dlp/admin/v1/test/process-text', 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://{host}/api/dlp/admin/v1/test/process-text",
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([
'plaintext' => '<string>',
'runtime_stage' => '<string>',
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => [
'model_alias' => '<string>',
'principal_ids' => [
'<string>'
],
'provider_id' => '<string>',
'provider_ids' => [
'<string>'
]
],
'structured_payload_json' => '<string>',
'tool_name' => '<string>',
'user_groups' => [
'<string>'
],
'user_roles' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{host}/api/dlp/admin/v1/test/process-text"
payload := strings.NewReader("{\n \"plaintext\": \"<string>\",\n \"runtime_stage\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"model_alias\": \"<string>\",\n \"principal_ids\": [\n \"<string>\"\n ],\n \"provider_id\": \"<string>\",\n \"provider_ids\": [\n \"<string>\"\n ]\n },\n \"structured_payload_json\": \"<string>\",\n \"tool_name\": \"<string>\",\n \"user_groups\": [\n \"<string>\"\n ],\n \"user_roles\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{host}/api/dlp/admin/v1/test/process-text")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plaintext\": \"<string>\",\n \"runtime_stage\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"model_alias\": \"<string>\",\n \"principal_ids\": [\n \"<string>\"\n ],\n \"provider_id\": \"<string>\",\n \"provider_ids\": [\n \"<string>\"\n ]\n },\n \"structured_payload_json\": \"<string>\",\n \"tool_name\": \"<string>\",\n \"user_groups\": [\n \"<string>\"\n ],\n \"user_roles\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/dlp/admin/v1/test/process-text")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plaintext\": \"<string>\",\n \"runtime_stage\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"model_alias\": \"<string>\",\n \"principal_ids\": [\n \"<string>\"\n ],\n \"provider_id\": \"<string>\",\n \"provider_ids\": [\n \"<string>\"\n ]\n },\n \"structured_payload_json\": \"<string>\",\n \"tool_name\": \"<string>\",\n \"user_groups\": [\n \"<string>\"\n ],\n \"user_roles\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"duration_ms": 1,
"findings": [
{
"action_taken": "<string>",
"confidence": "<string>",
"detection_group": "<string>",
"detection_type": "<string>",
"dry_run": true,
"payload_kind": "<string>",
"payload_level": true,
"provider": "<string>",
"rule_id": "<string>",
"rule_source": "<string>",
"runtime_stage": "<string>",
"severity": "<string>",
"span_end": 1,
"span_start": 1,
"field_path": "<string>",
"tool_name": "<string>"
}
],
"processed_text": "<string>",
"resolved_policy": {
"rules": [
{
"action_scope": "<string>",
"attribution": {
"rule_id": "<string>",
"scope": {
"model_alias": "<string>",
"principal_ids": [
"<string>"
],
"provider_id": "<string>",
"provider_ids": [
"<string>"
]
},
"source": "<string>",
"policy_id": "<string>",
"policy_name": "<string>"
},
"detection_type": "<string>",
"dry_run": true,
"effective_action": "<string>",
"min_confidence": "<string>",
"runtime_stage": "<string>",
"condition_equals": "<string>",
"condition_field_path": "<string>",
"detection_engine_id": "<string>",
"detection_engine_name": "<string>",
"policy_id": "<string>",
"target_field_path": "<string>",
"tool_name": "<string>",
"tool_names": [
"<string>"
]
}
]
},
"verdict": "<string>",
"block_reason": "<string>",
"processed_structured_payload_json": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Data Control Center
Run a sample through the organization's live DLP pipeline
POST
/
api
/
dlp
/
admin
/
v1
/
test
/
process-text
Run a sample through the organization's live DLP pipeline
curl --request POST \
--url https://{host}/api/dlp/admin/v1/test/process-text \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plaintext": "<string>",
"runtime_stage": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"model_alias": "<string>",
"principal_ids": [
"<string>"
],
"provider_id": "<string>",
"provider_ids": [
"<string>"
]
},
"structured_payload_json": "<string>",
"tool_name": "<string>",
"user_groups": [
"<string>"
],
"user_roles": [
"<string>"
]
}
'import requests
url = "https://{host}/api/dlp/admin/v1/test/process-text"
payload = {
"plaintext": "<string>",
"runtime_stage": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"model_alias": "<string>",
"principal_ids": ["<string>"],
"provider_id": "<string>",
"provider_ids": ["<string>"]
},
"structured_payload_json": "<string>",
"tool_name": "<string>",
"user_groups": ["<string>"],
"user_roles": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plaintext: '<string>',
runtime_stage: '<string>',
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: {
model_alias: '<string>',
principal_ids: ['<string>'],
provider_id: '<string>',
provider_ids: ['<string>']
},
structured_payload_json: '<string>',
tool_name: '<string>',
user_groups: ['<string>'],
user_roles: ['<string>']
})
};
fetch('https://{host}/api/dlp/admin/v1/test/process-text', 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://{host}/api/dlp/admin/v1/test/process-text",
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([
'plaintext' => '<string>',
'runtime_stage' => '<string>',
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => [
'model_alias' => '<string>',
'principal_ids' => [
'<string>'
],
'provider_id' => '<string>',
'provider_ids' => [
'<string>'
]
],
'structured_payload_json' => '<string>',
'tool_name' => '<string>',
'user_groups' => [
'<string>'
],
'user_roles' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{host}/api/dlp/admin/v1/test/process-text"
payload := strings.NewReader("{\n \"plaintext\": \"<string>\",\n \"runtime_stage\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"model_alias\": \"<string>\",\n \"principal_ids\": [\n \"<string>\"\n ],\n \"provider_id\": \"<string>\",\n \"provider_ids\": [\n \"<string>\"\n ]\n },\n \"structured_payload_json\": \"<string>\",\n \"tool_name\": \"<string>\",\n \"user_groups\": [\n \"<string>\"\n ],\n \"user_roles\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{host}/api/dlp/admin/v1/test/process-text")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plaintext\": \"<string>\",\n \"runtime_stage\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"model_alias\": \"<string>\",\n \"principal_ids\": [\n \"<string>\"\n ],\n \"provider_id\": \"<string>\",\n \"provider_ids\": [\n \"<string>\"\n ]\n },\n \"structured_payload_json\": \"<string>\",\n \"tool_name\": \"<string>\",\n \"user_groups\": [\n \"<string>\"\n ],\n \"user_roles\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/dlp/admin/v1/test/process-text")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plaintext\": \"<string>\",\n \"runtime_stage\": \"<string>\",\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"model_alias\": \"<string>\",\n \"principal_ids\": [\n \"<string>\"\n ],\n \"provider_id\": \"<string>\",\n \"provider_ids\": [\n \"<string>\"\n ]\n },\n \"structured_payload_json\": \"<string>\",\n \"tool_name\": \"<string>\",\n \"user_groups\": [\n \"<string>\"\n ],\n \"user_roles\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"duration_ms": 1,
"findings": [
{
"action_taken": "<string>",
"confidence": "<string>",
"detection_group": "<string>",
"detection_type": "<string>",
"dry_run": true,
"payload_kind": "<string>",
"payload_level": true,
"provider": "<string>",
"rule_id": "<string>",
"rule_source": "<string>",
"runtime_stage": "<string>",
"severity": "<string>",
"span_end": 1,
"span_start": 1,
"field_path": "<string>",
"tool_name": "<string>"
}
],
"processed_text": "<string>",
"resolved_policy": {
"rules": [
{
"action_scope": "<string>",
"attribution": {
"rule_id": "<string>",
"scope": {
"model_alias": "<string>",
"principal_ids": [
"<string>"
],
"provider_id": "<string>",
"provider_ids": [
"<string>"
]
},
"source": "<string>",
"policy_id": "<string>",
"policy_name": "<string>"
},
"detection_type": "<string>",
"dry_run": true,
"effective_action": "<string>",
"min_confidence": "<string>",
"runtime_stage": "<string>",
"condition_equals": "<string>",
"condition_field_path": "<string>",
"detection_engine_id": "<string>",
"detection_engine_name": "<string>",
"policy_id": "<string>",
"target_field_path": "<string>",
"tool_name": "<string>",
"tool_names": [
"<string>"
]
}
]
},
"verdict": "<string>",
"block_reason": "<string>",
"processed_structured_payload_json": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
ApiKeyOAuth2
A Barndoor API key, sent as Authorization: Bearer <key>. Keys are prefixed bdai_ and are opaque — do not attempt to decode one. Interchangeable with an OAuth 2.0 access token.
Body
application/json
Response
The verdict, findings and resolved policy for the sample