DEVELOPER REFERENCE

One API. Your event workflow.

Read workspace events and devices from your application or an AI agent. Organization-scoped keys keep access explicit.

Authentication

Create a named, expiring key under Console → Settings → API keys. Send it as a Bearer token. Logged-in console users use their session instead; no API key is needed in the UI.

export SMARTDETECTOR_URL=http://localhost:8082
export SMARTDETECTOR_API_KEY='YOUR_READ_ONLY_KEY'
curl "$SMARTDETECTOR_URL/api/v1/incidents?limit=10" \
  -H "Authorization: Bearer $SMARTDETECTOR_API_KEY"

Read endpoints

Method / pathKey scopeReturns
GET /api/v1/incidents?limit=10events:readRecent events, newest first.
GET /api/v1/incidents/{id}events:readOne event with observations and existing AI context.
GET /api/v1/devices?limit=10devices:readRegistered device status and last heartbeat.
GET /api/v1/devices/{id}devices:readOne device in your organization.

List limits are 1–50 (default 50). Responses are JSON arrays, not paginated envelopes. Event IDs and device IDs come from the corresponding list endpoint.

Event response

[
  {
    "incidentId": "example-event",
    "serverId": "example-camera",
    "state": "review",
    "startedAt": "2026-10-09T12:00:00Z",
    "updatedAt": "2026-10-09T12:00:00Z",
    "payload": {
      "kind": "vision-review",
      "source": "manual",
      "advisory": true,
      "assessment": "Visual observation for human review; not an intruder or emergency determination."
    }
  }
]

Illustrative schema example, not a live detection. Payloads vary by sensor, source, and optional AI enrichment.

Errors and boundaries

Read keys cannot create alarms, approve TVs, change providers, or administer users. Keep keys server-side. Do not put keys into public browser code.

Camera and AI pipeline

The authorized Ring adapter fetches recorded snapshots and submits sampled frames to the deployment’s AutoVision service. Visual reviews are stored in SmartDetector. The incident worker can add optional Bedrock context when its deployment role and model are configured. This is not a public anonymous video upload endpoint.

Use the console for providers, users, billing, event review, and Fire TV pairing.