Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docs on exports API endpoints #14224

Merged
merged 2 commits into from
Oct 9, 2024
Merged

Improve docs on exports API endpoints #14224

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4c3701
Add (optional) export name to the create-export API endpoint docs
SpangleLabs Oct 8, 2024
83d64a9
Add the exports list endpoint to the docs
SpangleLabs Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/docs/integrations/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<camera>/start/<start-timestamp>/end/<end-timestamp>`

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
}
```

Expand Down