Learn · SDK reference
The API
One base, one credential, one error shape — and where every group of calls lives.
Checked against the product on · written for people writing code
Everything the platform does is reachable over plain HTTP with a JSON body. The SDKs wrap the same calls. A published description carries the complete surface, and the groups below are where a reader starts.
The base and the credential
BASE
https://api.dmzagent.com/v1Every path in this reference hangs off this base. The credential is a bearer token in the Authorization header. A browser session never authenticates an API call.
The groups
| Group | Base path | What it covers |
|---|---|---|
| Events | /v1/agent-stream · /v1/frames | Send events, read one back, read its story. |
| Guard | /v1/cb | Check a standing before a sensitive action. |
| Watched things | /v1/subjects | List, read, amend, and read at a past time or version. |
| Rules | /v1/policies | List, create, adopt a template, evaluate, complete. |
| Reviews | /v1/reviews · /v1/agent-outputs | Claim, resolve, escalate, hold, release, acknowledge. |
| Records | /v1/ledger | Read a range, read the head, verify the chain, export. |
| Compliance | /v1/compliance | Frameworks, controls, evidence, coverage, packs, campaigns. |
| Library | /v1/library · /v1/canons | Browse, read a manifest, install, publish, read a report card. |
| Feeds | /v1/connector-instances | Create, bind, run, dry-run, and tail a feed. |
| Keys | /v1/api-keys | List, create, revoke, and read the scope list. |
| Agents | /v1/agents · /v1/agent-graph | Define, run, and read an agent and its graph. |
The three calls most programs make
from dmzagent import DMZAgent
cx = DMZAgent(api_key="YOUR_API_KEY")
cx.emit_event(
"observation",
agent_subject_id="pump-12",
subject_type="sensor",
payload={"reading": 41.2, "unit": "F"},
)Placeholder values shown. Signed-in surfaces fill in your real key.
from dmzagent import DMZAgent
cx = DMZAgent(api_key="YOUR_API_KEY")
result = cx.check(subject_id="pump-12")
if result.allow:
reply = your_bot(user_message)curl -X POST 'https://api.dmzagent.com/v1/agent-outputs/OUTPUT_ID/ack' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"ack_ref": "TICKET-123"}'