add_stream

Register a stream and its monitoring configuration.

• Method: POST
• Path: /add_stream

Request Body

{
  "stream_url": "rtsp://camera/live",
  "name": "Warehouse Camera 01",
  "frame_rate": 5,
  "index_for_search": true,
  "search_index_types": ["image"],
  "regions": [],
  "lines": [],
  "notification": {},
  "recording": {},
  "effects": {}
}

Field	Type	Description
stream_url	string	RTSP URL for the stream.
name	string	Friendly stream name.
frame_rate	number	Processing frame rate.
index_for_search	boolean	Whether detections from this stream should be indexed for search.
search_index_types	string[]	Search index types to build when indexing is enabled.
regions	Region[]	Detection regions and configuration.
lines	Line[]	Optional named lines used by detection conditions.
notification	Notification	Optional notification settings.
recording	Recording	Optional recording settings.
effects	Effects	Optional overlay settings.

Success Response

{
  "success": true,
  "message": "stream successfully added",
  "data": null
}