An authenticated API and a real-time event stream.

Specification

A machine-readable specification of every operation is supplied with the deployment, alongside a written guide with examples. Ask for it when you request a demo.

Versioning

The path carries the version. One version, v1, exists today, and the specification supplied with a deployment matches that deployment. Changes are listed in the release notes.

Authentication

A person signs in and calls the API with their session. One automation token exists per deployment: it has platform-administrator rights across all organisations and names the organisation it acts in with a request header. For role-limited access, use an account; scoped tokens are not available. After set-up, a data call with neither is refused. The health report and the performance figures stay open to anyone who can reach the API port.

Read and write scope

For a person, reads need a role that may view or search, and changes need the role for that change: managing cameras, managing rules, triaging alerts, keeping the watchlist. A refusal names the missing permission. The automation token holds every permission.

Visibility

A caller sees only the cameras owned by or granted to the organisation it acts in, narrowed by a member's own camera scope. A record outside that view is reported as not found.

Module switches

For a person, a field or filter that belongs to a switched-off module, such as plates or scene readings, is left out or refused with a reason. The automation token is not held to an organisation's module switches.

{
  "kind": "event",
  "ts": 1790270162000,
  "data": {
    "id": 4182,
    "type": "zone_enter",
    "time": "2026-09-24T17:16:02Z",
    "camera_id": "loading-bay",
    "track_id": 9214,
    "payload": {
      "rule": "Vehicle in the yard after hours",
      "zone": "service-yard",
      "class": "car"
    },
    "snapshot": null
  }
}

{
  "kind": "alert",
  "ts": 1790270164000,
  "data": {
    "id": 2291,
    "rule_name": "Vehicle in the yard after hours",
    "severity": "warning",
    "status": "new",
    "acked_at": null
  }
}

POST /api/v1/rules
Authorization: Bearer <your token>
X-Org: <your organisation>

{
  "name": "Vehicle in the yard after hours",
  "camera_id": "loading-bay",
  "spec": {
    "when": { "type": "zone_enter", "zone": "service-yard", "class": "car" },
    "schedule": { "from": "22:00", "to": "06:00" },
    "throttle_s": 60,
    "severity": "warning"
  }
}

GET /api/v1/plates/GJ00VO4821/route?from=2026-09-24T17:00:00Z

{
  "plate": "GJ00VO4821",
  "fuzzy": true,
  "matched_plates": ["GJ00VO4821", "GJ00VD4821"],
  "cameras": 2,
  "points": [
    { "time": "2026-09-24T17:08:12Z", "camera_name": "Approach road",
      "plate": "GJ00VO4821", "conf": 0.84, "valid": true },
    { "time": "2026-09-24T17:12:10Z", "camera_name": "Car park",
      "plate": "GJ00VD4821", "conf": 0.62, "valid": true }
  ]
}

Samples are illustrative and use demonstration data. A zone event carries no still of its own, so its snapshot is null: follow track_id to the sighting and its still. The specification supplied with your deployment is the reference.

zone_enter, zone_exit

A followed object enters or leaves a drawn zone

line_cross

A drawn line is crossed, with its direction

loiter

Time in a zone passes the limit

object_left

An item or vehicle stays still past the limit

class_present

A count of a chosen object type is reached

plate_match

A plate read matches the organisation's watchlist; carries both plates and whether the match was exact

ai_context

An AI scene reading was produced for a sighting

camera_offline

A feed is still missing after repeated reconnection attempts

track_started, track_ended

A sighting begins or ends