> ## Documentation Index > Fetch the complete documentation index at: https://docs.cotool.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get structured threat model board > Get the structured per-surface board (lean generated layer + live detection-agent overlay). ## OpenAPI ````yaml https://app.cotool.ai/api/docs/openapi.json get /api/threat-model/board openapi: 3.1.0 info: title: Cotool API version: 1.0.0 description: >- The Cotool REST API. Authenticate with an API key from `/settings/api-keys` sent as `Authorization: Bearer `. Authentication, error formats, pagination, and common integration recipes are documented in the [API overview](https://docs.cotool.ai/api-reference/introduction). Endpoints marked **Deprecated** keep working; each one's description names its replacement. servers: - url: https://app.cotool.ai description: Production server security: - ApiKeyAuth: [] tags: - name: Agents description: Create, update, run, and version agents. - name: Agent Runs description: Inspect agent runs, submit feedback, and read evaluation metrics. - name: Agent Triggers description: Webhook, schedule, and integration triggers that start agent runs. - name: Agents as Code description: Validate agents and skills defined as YAML in a Git repository. - name: Skills description: Reusable instructions and tool grants attached to agents. - name: Chat description: Chat sessions and their transcripts. - name: Alerts description: Alert triage, routing, and escalation notifications. - name: Output Destinations description: Webhook, Slack, Jira, and Linear destinations for agent output. - name: Detections description: Detection agents, detection hits, and the Cotool detection library. - name: Hunt description: Autonomous hunt threats, gaps, and settings. - name: Intel description: Threat-intelligence feed items, indicators, and sources. - name: Threat Model description: The organization threat model and its version history. - name: MITRE Coverage description: MITRE ATT&CK coverage across detections. - name: Tools description: Connected tool integrations and captured tool output. - name: CLIs description: Connected CLI integrations. - name: Artifacts description: Files and reports produced by agent runs. - name: Audit Logs description: Organization audit log export and event catalog. - name: Users description: Users, memberships, and the current session. - name: Roles description: Role-based permissions. - name: Organizations description: Organization-level metrics. paths: /api/threat-model/board: get: tags: - Threat Model summary: Get structured threat model board description: >- Get the structured per-surface board (lean generated layer + live detection-agent overlay). responses: '200': description: Successful response content: application/json: schema: type: object properties: coverageRefreshPending: type: boolean description: >- Whether async inventory or surface classification updates are still refreshing coverage overlays. presentPlatforms: type: array items: type: string description: >- ATT&CK platforms the org runs (passthrough from the board projection); used to hide techniques for absent platforms. surfaces: type: array items: type: object properties: id: type: string enum: - identity - cloud - endpoint - saas - email - network - source-code - application label: type: string environment: type: object properties: summary: type: string components: type: array items: type: object properties: name: type: string description: >- A concrete thing on this surface, e.g. "Okta (acme.okta.com)". detail: type: string description: >- One-line characterization of that component. required: - name - detail required: - summary - components gaps: type: array items: type: string agents: type: array items: type: object properties: id: type: string name: type: string hits30d: type: integer runs30d: type: integer required: - id - name - hits30d - runs30d required: - id - label - environment - gaps - agents description: >- All fixed surfaces, ordered, with live detection-agent overlay. required: - presentPlatforms - surfaces '400': description: Bad request — input validation failed or the request was malformed content: application/json: schema: $ref: '#/components/schemas/ValidationError' '401': description: Unauthorized — missing or invalid API key / session content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden — the authenticated user lacks the required permissions content: application/json: schema: $ref: '#/components/schemas/PermissionError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: shell label: cURL source: |- curl -X GET "https://app.cotool.ai/api/threat-model/board" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" components: schemas: ValidationError: type: object properties: error: type: string description: Error message describing what went wrong issues: type: array description: >- Detailed validation issues, present when request or response schema validation fails items: type: object additionalProperties: true required: - error Error: type: object properties: error: type: string description: Error message describing what went wrong required: - error PermissionError: type: object properties: error: type: string description: Error message describing what went wrong missingPerms: type: array description: Permissions the authenticated user is missing for this operation items: type: string required: - error securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API Key description: >- API Key authentication for programmatic access. Include your API key in the Authorization header as: `Bearer your_api_key_here` ````