CFD API Reference
The Context Front Door API covers six functional areas: configuration, quarantine management, observability and metrics, pattern and intelligence management, canary credentials, and compliance exports. All endpoints require a Bearer token or API key unless otherwise noted. Base URL:https://api.mnemom.ai
Configuration
Control how CFD behaves — globally for the org, per-agent, or in bulk.| Method | Endpoint | Description |
|---|---|---|
GET | /v1/cfd/config | Retrieve org-level CFD defaults (thresholds, enforcement mode, enabled threat types) |
PUT | /v1/cfd/config | Update org-level defaults — applies to all agents that don’t have a per-agent override |
GET | /v1/agents/:id/cfd/config | Retrieve per-agent CFD config (shows effective config after inheritance from org) |
PUT | /v1/agents/:id/cfd/config | Update per-agent config — overrides org defaults for the specified fields only |
POST | /v1/cfd/config/bulk-apply | Apply a config patch to multiple agents at once |
Quarantine Management
Quarantined turns are held pending human review. Reviewers can release (with or without a false-positive flag) or confirm as a genuine threat.| Method | Endpoint | Description |
|---|---|---|
GET | /v1/cfd/quarantine | List quarantined items — filter by status, agent_id, threat_type, date range |
GET | /v1/cfd/quarantine/:id | Retrieve a single quarantine record with full evaluation detail |
DELETE | /v1/cfd/quarantine/:id | Delete a quarantine record (admin only; irreversible) |
POST | /v1/cfd/quarantine/:id/release | Release the quarantined turn to the agent; optionally mark as false positive |
POST | /v1/cfd/quarantine/:id/report | Confirm the quarantined turn as a genuine threat |
Query & Observability
Query the full evaluation history, aggregate metrics, and access a live SSE stream for real-time monitoring.| Method | Endpoint | Description |
|---|---|---|
GET | /v1/cfd/evaluations | Full evaluation log — filter by agent_id, verdict, threat_type, from, to, min_risk |
GET | /v1/cfd/metrics/summary | Aggregated counts: total evaluations, block rate, warn rate, false positive rate |
GET | /v1/cfd/metrics/timeseries | Time-bucketed metrics for charts — specify bucket (hour, day, week) |
GET | /v1/cfd/metrics/threats | Top threat types by volume and confidence over a time window |
GET | /v1/cfd/feed | SSE stream of live CFD events — connect once and receive events as they happen |
GET | /v1/cfd/sessions | List active sessions with elevated session risk (medium or high) |
cfd.evaluation.*, cfd.canary.*, cfd.session.*, and cfd.campaign.* events as they occur. Reconnect with Last-Event-ID to replay missed events (replays up to 10 minutes back).
Patterns & Intelligence
Manage the threat pattern library and retrieve adaptive threshold recommendations.| Method | Endpoint | Description |
|---|---|---|
GET | /v1/cfd/patterns | List active and candidate threat patterns — filter by status, threat_type |
POST | /v1/cfd/patterns | Submit a candidate pattern for review and potential promotion |
GET | /v1/cfd/threshold-suggestions | Adaptive threshold recommendations based on your false-positive and miss rate |
candidate status. The arena evaluation pipeline tests them against labeled benign and malicious message sets. Patterns that exceed precision/recall thresholds are promoted to active.
Canary Credentials
Canary credentials are honeypot API keys, tokens, or other secrets deliberately planted in the agent’s context. If an attacker extracts and uses them, CFD detects the use and fires acfd.canary.triggered event.
| Method | Endpoint | Description |
|---|---|---|
POST | /v1/cfd/canaries | Create a canary credential and associate it with an agent |
GET | /v1/cfd/canaries?agent_id= | List canaries for an agent |
GET | /v1/cfd/canaries/:id/status | Check whether a specific canary has been triggered |
credential value is returned only at creation time. CFD monitors for its appearance in outbound requests or inbound message content.
Check canary status:
Special Endpoints
Sovereign Agent Setup
One-call configuration for sovereign agents — applies hardened defaults, creates initial canaries, sets enforcement mode to block, and enables all threat types.Cross-Agent Campaign Detection
List detected attack campaigns — groups of related attacks targeting multiple agents from the same infrastructure.EU AI Act Compliance Export
Export CFD evaluation data in EU AI Act Article 50 compliance format.Accept: text/csv for spreadsheet-compatible export.
Error Responses
All CFD endpoints return standard Mnemom error objects:| HTTP Status | Meaning |
|---|---|
400 | Invalid request body or parameters |
401 | Missing or invalid authentication |
403 | Insufficient permissions for the requested operation |
404 | Resource not found |
429 | Rate limit exceeded |
500 | Internal server error |
Related
- CFD Threat Model — What each threat type means and how detection works
- CFD Webhooks — React to CFD events in real-time
- CFD Monitoring — Security Observatory and alert management
- Policy Overview — Policy enforcement runs alongside CFD