administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-02 17:25:22 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Nick Mowen 2022-03-11 14:31:04 -07:00
parent b55b1cb0f6
commit 4ce4450c77
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -186,6 +186,22 @@ Sets retain to true for the event id.
Sets retain to false for the event id (event may be deleted quickly after removing). Sets retain to false for the event id (event may be deleted quickly after removing).
### `POST /api/events/<id>/sub_label`
Set a sub label for a person event. For example to update `person` -> `person's name` if they were recognized with facial recognition.
```
Headers:
Content-Type: application/json
Body:
subLabel
```
### `DELETE /api/events/<id>/sub_label`
Clear the already set sub label to be blank.
### `GET /api/events/<id>/thumbnail.jpg` ### `GET /api/events/<id>/thumbnail.jpg`
Returns a thumbnail for the event id optimized for notifications. Works while the event is in progress and after completion. Passing `?format=android` will convert the thumbnail to 2:1 aspect ratio. Returns a thumbnail for the event id optimized for notifications. Works while the event is in progress and after completion. Passing `?format=android` will convert the thumbnail to 2:1 aspect ratio.