Open workspace
Reference

API reference

Use this page to wire ingest, incident inspection, balance checks, and key management.

Back to quickstartSee rollout checklist
Endpoints

Core routes

These routes cover request ingest, incident review, workspace visibility, and key issuance.

POST/v1/events

Submit normalized content events for moderation in sync or async mode.

  • Requires: Bearer API key
  • Body: { mode, event, options? }
GET/v1/incidents

List incidents for a workspace with optional operator-focused filters.

  • Requires: incidents:read scope (or admin token)
  • Query: scopeId, severity/status CSV, q, customInfo*, includeRecommendedActions
GET/v1/incidents/:id

Fetch one incident by id for a specific workspace scope.

  • Requires: scopeId query required
  • Query: scopeId, includeRecommendedActions?
PATCH/v1/incidents/:id

Update incident triage status.

  • Requires: scopeId query required
  • Body: { status } (for example resolved or dismissed)
GET/v1/dashboard/overview

Fetch workspace status, usage, and high-level moderation totals.

  • Requires: Bearer API key
POST/v1/api-keys

Issue scoped API keys for adapters and internal services.

  • Requires: Workspace owner/admin context
  • Body: { label, scopes, expiresAt? }
GET/v1/billing/credits

Read remaining moderation credits, granted total, and consumed total.

  • Requires: Bearer API key
Implementation notes

Scope incident reads carefully and keep key usage explicit

Incident reads need scope context, and key management should stay explicit enough that engineers can tell which workspace or service a request is associated with during debugging.

Incident scope matters

When reading a single incident or patching its status, make sure the request includes the same scopeId the original event carried. That is what prevents cross-scope confusion during support and review.

Use key scope intentionally

Adapter requests should be made with the workspace key that actually owns the moderation traffic. Avoid ambiguous shared credentials that make usage and incident ownership harder to reconstruct later.