administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-05 18:55:23 +03:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Correct docs and add json example

Browse Source
This commit is contained in:
Nick Mowen 2023-05-01 12:44:58 -06:00
parent 28f909baaa
commit ccf3b72467
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/docs/integrations/api.md
View File

@ -296,11 +296,18 @@ Get ffprobe output for camera feed paths.
Get PTZ info for the camera.
### `POST /api/events/manual/<camera_name>/<label>/create`
### `POST /api/events/<camera_name>/<label>/create`
Create a manual API with a given `label` (ex: doorbell press) to capture a specific event besides an object being detected.
NOTE: This call will return the unique ID for the event which will be required to `end` the event.
### `POST /api/events/manual/<event_id>/end`
```json
{
"subLabel": "some_string", // add sub label to event
"duration": 30, // predetermined length of event (default: 30 seconds) or can be to null for indeterminate length event
"include_recording": true // whether the event should save recordings along with the snapshot that is taken
}
```
End a specific manual event.
### `POST /api/events/<event_id>/end`
End a specific manual event without a predetermined length.