Docs Demo
Reference

API reference

The main endpoints used by the gateway and the dashboard. All requests are JSON.

Authentication

For programmatic access use the Authorization: Bearer ag_live_… header. For the dashboard, a session cookie.

Gateway

GET /api/gateway/resolve

Returns an agent's policy.

GET /api/gateway/resolve
Authorization: Bearer ag_live_xxx
X-Agent-Key: agk_xxx
{
  "agentId": "…",
  "agentKey": "agk_xxx",
  "name": "support-agent-v1",
  "orgId": "…",
  "policyYaml": "agent: support-agent-v1\n…"
}
CodeMeaning
400agentKey missing.
404No such agent (or it belongs to another tenant).
403The agent is paused.

POST /api/events/ingest

Sends redacted audit events. Body: { "events": [...] }, { "event": {...} } or a bare array. At most 100 events per request.

Events

EndpointDescription
GET /api/eventsEvent list (filterable).
GET /api/events/statsSummary counts.
GET /api/events/sessionsSession summaries.
GET /api/events/timeseriesTime series.
GET /api/events/insightsInsights.
GET /api/events/:correlationIdFull detail of a single call.

Policy

EndpointDescription
GET /api/policyThe current policy.
POST /api/policy/validateValidate YAML without saving.
PUT /api/policySave the policy.

Management

EndpointDescription
GET/POST/PUT/DELETE /api/agentsAgent registry.
GET/POST/DELETE /api/settings/keysAPI keys.
GET /api/statusSystem status.
NoteEndpoints are scoped per tenant and rate limited.