Add API docs

blakeblackshear · Dec 19, 2022 · a23f412 · a23f412
1 parent ec3212d
commit a23f412
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md
@@ -272,3 +272,12 @@ Get ffprobe output for camera feed paths.
 | param   | Type   | Description                        |
 | ------- | ------ | ---------------------------------- |
 | `paths` | string | `,` separated list of camera paths |
+
+### `POST /api/events/manual/<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`
+
+End a specific manual event.