diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 0c48c0c82..f0a844888 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -411,17 +411,37 @@ HTTP Live Streaming Video on Demand URL for the specified event. Can be viewed i HTTP Live Streaming Video on Demand URL for the camera with the specified time range. Can be viewed in an application like VLC. +### `GET /api/exports` + +Fetch a list of all export recordings + +Sample response: +```json +[ + { + "camera": "doorbell", + "date": 12800057, + "id": "doorbell_pjis54", + "in_progress": false, + "name": "2024-10-04 fox visit", + "thumb_path": "/media/frigate/clips/export/doorbell_pjis54.webp", + "video_path": "/media/frigate/exports/doorbell_pjis54.mp4" + } +] +``` + ### `POST /api/export//start//end/` Export recordings from `start-timestamp` to `end-timestamp` for `camera` as a single mp4 file. These recordings will be exported to the `/media/frigate/exports` folder. -It is also possible to export this recording as a time-lapse. +It is also possible to export this recording as a time-lapse using the "playback" key in the json body, or specify a custom export filename, using the "name" key. **Optional Body:** ```json { - "playback": "realtime" // playback factor: realtime or timelapse_25x + "playback": "realtime", // playback factor: realtime or timelapse_25x + "name": "custom export name" // override the default export filename with a custom name } ```