v1

latestOpenAPI 3.1.02026-07-244727109.8 KB

Custom Agents

Get list of agents

🚧 Alpha: Custom Agents is a new capability and still under active development. Endpoints, fields, and behavior may change without notice.

Returns every Threat Intelligence Agent — Custom Agents as well as the built-in TTP, Cyberattacks, Brand Monitoring, Vulnerability, and Credential Leaks agents.

To find your team's Custom Agents, filter the response for items where type is customAgent, then pass each one's id to GET /custom-agents/{id} to fetch that agent's rows.

get/dashboards

Response

A list of agents for the enterprise team.

Example response

[
  {
    "id": "174aa5c2-e63d-46ff-800e-8d344ba29d57",
    "type": "customAgent",
    "name": "Malware families targeting financial institutions",
    "created": 1783541284792,
    "createdBy": "c6d7e1e8-072b-42b8-9484-f873be3ce4dd",
    "pir": "What malware families are being used in attacks against financial institutions?",
    "pirMentions": [
      {
        "id": "enterprise/christeam/intelProfile/tx:OrganizationIntelligenceProfileShipbuildingandmaretimeindustry-gnpzbv",
        "type": "entityList",
        "mention": "@# Organization Intelligence Profile — Shipbuilding and maretime industry"
      }
    ],
    "schema": {
      "entityType": "threatActor",
      "entityTypeLabel": "APT Group",
      "columns": [
        {
          "id": "what-soWhat",
          "name": "What / So What",
          "type": "predefined"
        }
      ]
    }
  }
]