Frigate icon

Frigate

Control Frigate over its real-time /ws API

Set Review Detections

AI-generated

Summary

Toggles detection-level review items (GenAI summaries) on or off for a Frigate camera via the WebSocket API.

Inputs

  • camera (required) — The camera name as configured in Frigate.
  • value (required) — Whether to turn the feature on or off (ON/OFF).
  • awaitState — Whether to keep the socket open after publishing and wait for the matching /state read-back to confirm the new value.
  • awaitTimeoutMs — How long to wait for the /state read-back before giving up (0-600000 ms).

Output shape

A single item per input item with metadata about the operation.

When 'awaitState' is enabled, the returned item includes 'confirmed' (boolean) and 'stateValue' fields indicating read-back success and the read-back value.

Examples

Example 1: Enable detection-level review for a specific camera.

Operation: Set Review Detections, Camera: front_door, Value: ON, Await State: false

Example 2: Enable detection-level review and verify the change with a timeout.

Operation: Set Review Detections, Camera: front_door, Value: ON, Await State: true, Confirmation Timeout (Ms): 5000

Links

Discussion