Deterministic environment-aware signal prioritization
curl --request POST \
--url https://api.example.com/v2/prioritize \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"environment": {
"capabilities": [
"<string>"
],
"cloud_providers": [
"<string>"
],
"external_exposure": [
"<string>"
],
"geography": [
"<string>"
],
"hosting_model": "<string>",
"industry": "<string>",
"products": [
"<string>"
],
"vendors": [
"<string>"
]
},
"agent_context": {
"objective": "<string>",
"requested_outcome": "<string>",
"run_id": "<string>",
"step_id": "<string>",
"client": {
"agent_name": "<string>",
"agent_version": "<string>",
"framework": "<string>"
},
"constraints": {
"latency_budget_ms": 15025,
"max_results_budget": 100,
"min_resolution_confidence": 0.5,
"strict_mode": true
},
"parent_step_id": "<string>",
"tags": [
"<string>"
]
},
"expected_categories": [],
"include_debug": false,
"max_items": 20,
"seen_signal_ids": [
"<string>"
],
"seen_since": "2023-11-07T05:31:56Z",
"time_window_days": 30
}
'import requests
url = "https://api.example.com/v2/prioritize"
payload = {
"environment": {
"capabilities": ["<string>"],
"cloud_providers": ["<string>"],
"external_exposure": ["<string>"],
"geography": ["<string>"],
"hosting_model": "<string>",
"industry": "<string>",
"products": ["<string>"],
"vendors": ["<string>"]
},
"agent_context": {
"objective": "<string>",
"requested_outcome": "<string>",
"run_id": "<string>",
"step_id": "<string>",
"client": {
"agent_name": "<string>",
"agent_version": "<string>",
"framework": "<string>"
},
"constraints": {
"latency_budget_ms": 15025,
"max_results_budget": 100,
"min_resolution_confidence": 0.5,
"strict_mode": True
},
"parent_step_id": "<string>",
"tags": ["<string>"]
},
"expected_categories": [],
"include_debug": False,
"max_items": 20,
"seen_signal_ids": ["<string>"],
"seen_since": "2023-11-07T05:31:56Z",
"time_window_days": 30
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
environment: {
capabilities: ['<string>'],
cloud_providers: ['<string>'],
external_exposure: ['<string>'],
geography: ['<string>'],
hosting_model: '<string>',
industry: '<string>',
products: ['<string>'],
vendors: ['<string>']
},
agent_context: {
objective: '<string>',
requested_outcome: '<string>',
run_id: '<string>',
step_id: '<string>',
client: {agent_name: '<string>', agent_version: '<string>', framework: '<string>'},
constraints: {
latency_budget_ms: 15025,
max_results_budget: 100,
min_resolution_confidence: 0.5,
strict_mode: true
},
parent_step_id: '<string>',
tags: ['<string>']
},
expected_categories: [],
include_debug: false,
max_items: 20,
seen_signal_ids: ['<string>'],
seen_since: '2023-11-07T05:31:56Z',
time_window_days: 30
})
};
fetch('https://api.example.com/v2/prioritize', 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/v2/prioritize",
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([
'environment' => [
'capabilities' => [
'<string>'
],
'cloud_providers' => [
'<string>'
],
'external_exposure' => [
'<string>'
],
'geography' => [
'<string>'
],
'hosting_model' => '<string>',
'industry' => '<string>',
'products' => [
'<string>'
],
'vendors' => [
'<string>'
]
],
'agent_context' => [
'objective' => '<string>',
'requested_outcome' => '<string>',
'run_id' => '<string>',
'step_id' => '<string>',
'client' => [
'agent_name' => '<string>',
'agent_version' => '<string>',
'framework' => '<string>'
],
'constraints' => [
'latency_budget_ms' => 15025,
'max_results_budget' => 100,
'min_resolution_confidence' => 0.5,
'strict_mode' => true
],
'parent_step_id' => '<string>',
'tags' => [
'<string>'
]
],
'expected_categories' => [
],
'include_debug' => false,
'max_items' => 20,
'seen_signal_ids' => [
'<string>'
],
'seen_since' => '2023-11-07T05:31:56Z',
'time_window_days' => 30
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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/v2/prioritize"
payload := strings.NewReader("{\n \"environment\": {\n \"capabilities\": [\n \"<string>\"\n ],\n \"cloud_providers\": [\n \"<string>\"\n ],\n \"external_exposure\": [\n \"<string>\"\n ],\n \"geography\": [\n \"<string>\"\n ],\n \"hosting_model\": \"<string>\",\n \"industry\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"vendors\": [\n \"<string>\"\n ]\n },\n \"agent_context\": {\n \"objective\": \"<string>\",\n \"requested_outcome\": \"<string>\",\n \"run_id\": \"<string>\",\n \"step_id\": \"<string>\",\n \"client\": {\n \"agent_name\": \"<string>\",\n \"agent_version\": \"<string>\",\n \"framework\": \"<string>\"\n },\n \"constraints\": {\n \"latency_budget_ms\": 15025,\n \"max_results_budget\": 100,\n \"min_resolution_confidence\": 0.5,\n \"strict_mode\": true\n },\n \"parent_step_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"expected_categories\": [],\n \"include_debug\": false,\n \"max_items\": 20,\n \"seen_signal_ids\": [\n \"<string>\"\n ],\n \"seen_since\": \"2023-11-07T05:31:56Z\",\n \"time_window_days\": 30\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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/v2/prioritize")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"environment\": {\n \"capabilities\": [\n \"<string>\"\n ],\n \"cloud_providers\": [\n \"<string>\"\n ],\n \"external_exposure\": [\n \"<string>\"\n ],\n \"geography\": [\n \"<string>\"\n ],\n \"hosting_model\": \"<string>\",\n \"industry\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"vendors\": [\n \"<string>\"\n ]\n },\n \"agent_context\": {\n \"objective\": \"<string>\",\n \"requested_outcome\": \"<string>\",\n \"run_id\": \"<string>\",\n \"step_id\": \"<string>\",\n \"client\": {\n \"agent_name\": \"<string>\",\n \"agent_version\": \"<string>\",\n \"framework\": \"<string>\"\n },\n \"constraints\": {\n \"latency_budget_ms\": 15025,\n \"max_results_budget\": 100,\n \"min_resolution_confidence\": 0.5,\n \"strict_mode\": true\n },\n \"parent_step_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"expected_categories\": [],\n \"include_debug\": false,\n \"max_items\": 20,\n \"seen_signal_ids\": [\n \"<string>\"\n ],\n \"seen_since\": \"2023-11-07T05:31:56Z\",\n \"time_window_days\": 30\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/prioritize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment\": {\n \"capabilities\": [\n \"<string>\"\n ],\n \"cloud_providers\": [\n \"<string>\"\n ],\n \"external_exposure\": [\n \"<string>\"\n ],\n \"geography\": [\n \"<string>\"\n ],\n \"hosting_model\": \"<string>\",\n \"industry\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"vendors\": [\n \"<string>\"\n ]\n },\n \"agent_context\": {\n \"objective\": \"<string>\",\n \"requested_outcome\": \"<string>\",\n \"run_id\": \"<string>\",\n \"step_id\": \"<string>\",\n \"client\": {\n \"agent_name\": \"<string>\",\n \"agent_version\": \"<string>\",\n \"framework\": \"<string>\"\n },\n \"constraints\": {\n \"latency_budget_ms\": 15025,\n \"max_results_budget\": 100,\n \"min_resolution_confidence\": 0.5,\n \"strict_mode\": true\n },\n \"parent_step_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"expected_categories\": [],\n \"include_debug\": false,\n \"max_items\": 20,\n \"seen_signal_ids\": [\n \"<string>\"\n ],\n \"seen_since\": \"2023-11-07T05:31:56Z\",\n \"time_window_days\": 30\n}"
response = http.request(request)
puts response.read_body{
"generated_at": "<string>",
"items": [
{
"confidence_score": 0.5,
"environment_match_reasons": [
"<string>"
],
"freshness_score": 0.5,
"is_new_to_requester": true,
"novelty_score": 0.5,
"priority_score": 0.5,
"recommended_action_summary": "<string>",
"signal_id": "<string>",
"supporting_evidence": [
{
"evidence_id": "<string>",
"evidence_type": "<string>",
"published_at": "<string>",
"source": "<string>"
}
],
"suppression_reasons": [
"<string>"
],
"title": "<string>",
"what_changed": [
"<string>"
],
"debug": {},
"first_seen": "<string>",
"last_seen": "<string>"
}
],
"meta": {
"candidate_count": 1,
"implemented_categories": [],
"ranked_count": 1,
"requested_categories": [],
"truncated": true,
"unimplemented_categories": [],
"budget": {
"candidate_limit_per_category": 2,
"candidate_limit_total": 2,
"report_ids_per_candidate": 2,
"supporting_reports_per_item": 2
}
},
"window_end": "<string>",
"window_start": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Prioritize
Prioritize signals
POST
/
v2
/
prioritize
Deterministic environment-aware signal prioritization
curl --request POST \
--url https://api.example.com/v2/prioritize \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"environment": {
"capabilities": [
"<string>"
],
"cloud_providers": [
"<string>"
],
"external_exposure": [
"<string>"
],
"geography": [
"<string>"
],
"hosting_model": "<string>",
"industry": "<string>",
"products": [
"<string>"
],
"vendors": [
"<string>"
]
},
"agent_context": {
"objective": "<string>",
"requested_outcome": "<string>",
"run_id": "<string>",
"step_id": "<string>",
"client": {
"agent_name": "<string>",
"agent_version": "<string>",
"framework": "<string>"
},
"constraints": {
"latency_budget_ms": 15025,
"max_results_budget": 100,
"min_resolution_confidence": 0.5,
"strict_mode": true
},
"parent_step_id": "<string>",
"tags": [
"<string>"
]
},
"expected_categories": [],
"include_debug": false,
"max_items": 20,
"seen_signal_ids": [
"<string>"
],
"seen_since": "2023-11-07T05:31:56Z",
"time_window_days": 30
}
'import requests
url = "https://api.example.com/v2/prioritize"
payload = {
"environment": {
"capabilities": ["<string>"],
"cloud_providers": ["<string>"],
"external_exposure": ["<string>"],
"geography": ["<string>"],
"hosting_model": "<string>",
"industry": "<string>",
"products": ["<string>"],
"vendors": ["<string>"]
},
"agent_context": {
"objective": "<string>",
"requested_outcome": "<string>",
"run_id": "<string>",
"step_id": "<string>",
"client": {
"agent_name": "<string>",
"agent_version": "<string>",
"framework": "<string>"
},
"constraints": {
"latency_budget_ms": 15025,
"max_results_budget": 100,
"min_resolution_confidence": 0.5,
"strict_mode": True
},
"parent_step_id": "<string>",
"tags": ["<string>"]
},
"expected_categories": [],
"include_debug": False,
"max_items": 20,
"seen_signal_ids": ["<string>"],
"seen_since": "2023-11-07T05:31:56Z",
"time_window_days": 30
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
environment: {
capabilities: ['<string>'],
cloud_providers: ['<string>'],
external_exposure: ['<string>'],
geography: ['<string>'],
hosting_model: '<string>',
industry: '<string>',
products: ['<string>'],
vendors: ['<string>']
},
agent_context: {
objective: '<string>',
requested_outcome: '<string>',
run_id: '<string>',
step_id: '<string>',
client: {agent_name: '<string>', agent_version: '<string>', framework: '<string>'},
constraints: {
latency_budget_ms: 15025,
max_results_budget: 100,
min_resolution_confidence: 0.5,
strict_mode: true
},
parent_step_id: '<string>',
tags: ['<string>']
},
expected_categories: [],
include_debug: false,
max_items: 20,
seen_signal_ids: ['<string>'],
seen_since: '2023-11-07T05:31:56Z',
time_window_days: 30
})
};
fetch('https://api.example.com/v2/prioritize', 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/v2/prioritize",
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([
'environment' => [
'capabilities' => [
'<string>'
],
'cloud_providers' => [
'<string>'
],
'external_exposure' => [
'<string>'
],
'geography' => [
'<string>'
],
'hosting_model' => '<string>',
'industry' => '<string>',
'products' => [
'<string>'
],
'vendors' => [
'<string>'
]
],
'agent_context' => [
'objective' => '<string>',
'requested_outcome' => '<string>',
'run_id' => '<string>',
'step_id' => '<string>',
'client' => [
'agent_name' => '<string>',
'agent_version' => '<string>',
'framework' => '<string>'
],
'constraints' => [
'latency_budget_ms' => 15025,
'max_results_budget' => 100,
'min_resolution_confidence' => 0.5,
'strict_mode' => true
],
'parent_step_id' => '<string>',
'tags' => [
'<string>'
]
],
'expected_categories' => [
],
'include_debug' => false,
'max_items' => 20,
'seen_signal_ids' => [
'<string>'
],
'seen_since' => '2023-11-07T05:31:56Z',
'time_window_days' => 30
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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/v2/prioritize"
payload := strings.NewReader("{\n \"environment\": {\n \"capabilities\": [\n \"<string>\"\n ],\n \"cloud_providers\": [\n \"<string>\"\n ],\n \"external_exposure\": [\n \"<string>\"\n ],\n \"geography\": [\n \"<string>\"\n ],\n \"hosting_model\": \"<string>\",\n \"industry\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"vendors\": [\n \"<string>\"\n ]\n },\n \"agent_context\": {\n \"objective\": \"<string>\",\n \"requested_outcome\": \"<string>\",\n \"run_id\": \"<string>\",\n \"step_id\": \"<string>\",\n \"client\": {\n \"agent_name\": \"<string>\",\n \"agent_version\": \"<string>\",\n \"framework\": \"<string>\"\n },\n \"constraints\": {\n \"latency_budget_ms\": 15025,\n \"max_results_budget\": 100,\n \"min_resolution_confidence\": 0.5,\n \"strict_mode\": true\n },\n \"parent_step_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"expected_categories\": [],\n \"include_debug\": false,\n \"max_items\": 20,\n \"seen_signal_ids\": [\n \"<string>\"\n ],\n \"seen_since\": \"2023-11-07T05:31:56Z\",\n \"time_window_days\": 30\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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/v2/prioritize")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"environment\": {\n \"capabilities\": [\n \"<string>\"\n ],\n \"cloud_providers\": [\n \"<string>\"\n ],\n \"external_exposure\": [\n \"<string>\"\n ],\n \"geography\": [\n \"<string>\"\n ],\n \"hosting_model\": \"<string>\",\n \"industry\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"vendors\": [\n \"<string>\"\n ]\n },\n \"agent_context\": {\n \"objective\": \"<string>\",\n \"requested_outcome\": \"<string>\",\n \"run_id\": \"<string>\",\n \"step_id\": \"<string>\",\n \"client\": {\n \"agent_name\": \"<string>\",\n \"agent_version\": \"<string>\",\n \"framework\": \"<string>\"\n },\n \"constraints\": {\n \"latency_budget_ms\": 15025,\n \"max_results_budget\": 100,\n \"min_resolution_confidence\": 0.5,\n \"strict_mode\": true\n },\n \"parent_step_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"expected_categories\": [],\n \"include_debug\": false,\n \"max_items\": 20,\n \"seen_signal_ids\": [\n \"<string>\"\n ],\n \"seen_since\": \"2023-11-07T05:31:56Z\",\n \"time_window_days\": 30\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/prioritize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"environment\": {\n \"capabilities\": [\n \"<string>\"\n ],\n \"cloud_providers\": [\n \"<string>\"\n ],\n \"external_exposure\": [\n \"<string>\"\n ],\n \"geography\": [\n \"<string>\"\n ],\n \"hosting_model\": \"<string>\",\n \"industry\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"vendors\": [\n \"<string>\"\n ]\n },\n \"agent_context\": {\n \"objective\": \"<string>\",\n \"requested_outcome\": \"<string>\",\n \"run_id\": \"<string>\",\n \"step_id\": \"<string>\",\n \"client\": {\n \"agent_name\": \"<string>\",\n \"agent_version\": \"<string>\",\n \"framework\": \"<string>\"\n },\n \"constraints\": {\n \"latency_budget_ms\": 15025,\n \"max_results_budget\": 100,\n \"min_resolution_confidence\": 0.5,\n \"strict_mode\": true\n },\n \"parent_step_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"expected_categories\": [],\n \"include_debug\": false,\n \"max_items\": 20,\n \"seen_signal_ids\": [\n \"<string>\"\n ],\n \"seen_since\": \"2023-11-07T05:31:56Z\",\n \"time_window_days\": 30\n}"
response = http.request(request)
puts response.read_body{
"generated_at": "<string>",
"items": [
{
"confidence_score": 0.5,
"environment_match_reasons": [
"<string>"
],
"freshness_score": 0.5,
"is_new_to_requester": true,
"novelty_score": 0.5,
"priority_score": 0.5,
"recommended_action_summary": "<string>",
"signal_id": "<string>",
"supporting_evidence": [
{
"evidence_id": "<string>",
"evidence_type": "<string>",
"published_at": "<string>",
"source": "<string>"
}
],
"suppression_reasons": [
"<string>"
],
"title": "<string>",
"what_changed": [
"<string>"
],
"debug": {},
"first_seen": "<string>",
"last_seen": "<string>"
}
],
"meta": {
"candidate_count": 1,
"implemented_categories": [],
"ranked_count": 1,
"requested_categories": [],
"truncated": true,
"unimplemented_categories": [],
"budget": {
"candidate_limit_per_category": 2,
"candidate_limit_total": 2,
"report_ids_per_candidate": 2,
"supporting_reports_per_item": 2
}
},
"window_end": "<string>",
"window_start": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Scope and credits
| Requirement | Value |
|---|---|
| Required scopes | read:prioritize |
| Credits | 8 credits per request |
Authorizations
ApiKey <key_id>:
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
vulnerability, campaign, actor_activity, malware_activity, ioc_cluster, technique_cluster, identity_abuse, vendor_risk_cluster Required range:
1 <= x <= 100Maximum array length:
500Maximum string length:
128Required range:
1 <= x <= 180Was this page helpful?
⌘I
.png?fit=max&auto=format&n=u7saXgSwhIjXsY7P&q=85&s=66da6f97e851defcb12af05b800a8a27)
.png?fit=max&auto=format&n=u7saXgSwhIjXsY7P&q=85&s=37df025ce7a3cc54dd90f8edad1cf54f)