diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 6e4414927..bf1a79384 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -300,6 +300,8 @@ Get PTZ info for the camera. Create a manual API with a given `label` (ex: doorbell press) to capture a specific event besides an object being detected. +**Optional Body:** + ```json { "subLabel": "some_string", // add sub label to event @@ -308,6 +310,19 @@ Create a manual API with a given `label` (ex: doorbell press) to capture a speci } ``` -### `POST /api/events//end` +**Success Response:** + +```json +[ + { + "event_id": "1682970645.13116-1ug7ns", + "message": "Successfully created event.", + "success": true + }, + 200 +] +``` + +### `PUT /api/events//end` End a specific manual event without a predetermined length. diff --git a/frigate/http.py b/frigate/http.py index b9f273d32..7605c9bec 100644 --- a/frigate/http.py +++ b/frigate/http.py @@ -885,7 +885,7 @@ def create_event(camera_name, label): ) -@bp.route("/events//end", methods=["POST"]) +@bp.route("/events//end", methods=["PUT"]) def end_event(event_id): try: current_app.external_processor.finish_manual_event(event_id)