Skip to main content
POST
/
api
/
detections
/
generate-plan
cURL
curl -X POST "https://app.cotool.ai/api/detections/generate-plan" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"intent":"string","toolNames":["string"],"cliNames":["string"],"detectionCadence":"hourly","detectionId":"string"}'
import requests

url = "https://app.cotool.ai/api/detections/generate-plan"

payload = {
"intent": "<string>",
"toolNames": ["<string>"],
"cliNames": ["<string>"],
"detectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
intent: '<string>',
toolNames: ['<string>'],
cliNames: ['<string>'],
detectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};

fetch('https://app.cotool.ai/api/detections/generate-plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
HttpResponse<String> response = Unirest.post("https://app.cotool.ai/api/detections/generate-plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"intent\": \"<string>\",\n \"toolNames\": [\n \"<string>\"\n ],\n \"cliNames\": [\n \"<string>\"\n ],\n \"detectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.cotool.ai/api/detections/generate-plan"

payload := strings.NewReader("{\n \"intent\": \"<string>\",\n \"toolNames\": [\n \"<string>\"\n ],\n \"cliNames\": [\n \"<string>\"\n ],\n \"detectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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))

}
{
  "investigationPlan": "<string>",
  "steps": [
    {
      "title": "<string>",
      "instructions": "<string>"
    }
  ],
  "systemPrompt": "<string>"
}
{
"error": "<string>",
"issues": [
{}
]
}
{
"error": "<string>"
}
{
"error": "<string>",
"missingPerms": [
"<string>"
]
}
{
"error": "<string>"
}

Authorizations

Authorization
string
header
required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Body

application/json
intent
string
required

What the detection should look for and why

Minimum string length: 1
toolNames
string[]
required

Tool names available to the detection agent (used to infer data sources)

cliNames
string[]

CLI integration ids available to the detection agent (used as data sources at runtime)

detectionCadence
enum<string> | null

Cadence the detection will run on; the runtime prompt derives the primary lookback window from this metadata

Available options:
hourly,
daily,
weekly,
null
detectionId
string<uuid>

Optional detection ID when regenerating a plan for an existing detection

Response

Successful response

investigationPlan
string
required

Markdown investigation plan for backwards compatibility.

steps
object[]
required

Structured investigation plan steps.

Minimum array length: 1
systemPrompt
string
required

The assembled system prompt with intent + plan embedded