diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 51887b14b..1be8ff8ad 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -168,6 +168,16 @@ Events from the database. Accepts the following query string parameters: | `include_thumbnails` | int | Include thumbnails in the response (0 or 1) | | `in_progress` | int | Limit to events in progress (0 or 1) | +### `GET /api/timeline` + +Timeline of key moments of an event(s) from the database. Accepts the following query string parameters: + +| param | Type | Description | +| -------------------- | ---- | --------------------------------------------- | +| `camera` | int | Epoch time | +| `source_id` | str | , separated list of cameras | +| `limit` | int | Limit the number of events returned | + ### `GET /api/events/summary` Returns summary data for events in the database. Used by the Home Assistant integration. @@ -233,6 +243,10 @@ Accepts the following query string parameters, but they are only applied when an Returns the snapshot image from the latest event for the given camera and label combo. Using `any` as the label will return the latest thumbnail regardless of type. +### `GET /api//recording//snapshot.png` + +Returns the snapshot image from the specific point in that cameras recordings. + ### `GET /clips/-.jpg` JPG snapshot for the given camera and event id.