diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index b324aae36..a0208bc01 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -381,9 +381,13 @@ List of frames in the preview cache for the time range. Previews are only kept i Specific preview frame from preview cache. -### `GET //start//end//preview.gif` +### `GET //start//end//preview` -Gif made from preview video / frames during this time range +Looping image made from preview video / frames during this time range. + +| param | Type | Description | +| --------- | ---- | -------------------------------- | +| `format` | str | Format of preview [`gif`, `mp4`] | ## Recordings @@ -455,6 +459,10 @@ Reviews from the database. Accepts the following query string parameters: | `limit` | int | Limit the number of events returned | | `severity` | str | Limit items to severity (alert, detection, significant_motion) | +### `GET /api/review/` + +Get review with `id` from the database. + ### `GET /api/review/summary` Summary of reviews for the last 30 days. Accepts the following query string parameters: