AddStream
Request-body reference for POST /add_stream.
Example
{
"stream_url": "rtsp://camera/live",
"name": "Warehouse Camera 01",
"frame_rate": 5,
"index_for_search": true,
"search_index_types": ["image"],
"regions": [],
"lines": [],
"notification": { "include_image": true },
"recording": { "enabled": false },
"effects": { "show_bounding_boxes": true }
}
Fields
| Field | Type | Description |
|---|---|---|
stream_url | string | RTSP URL for the stream. |
name | string | Stream display name. |
frame_rate | number | Processing frame rate. |
index_for_search | boolean | Whether detections should be indexed for search. |
search_index_types | string[] | Search index types to build. |
regions | Region[] | Detection regions. |
lines | Line[] | Optional named lines. |
notification | Notification | Optional notification settings. |
recording | Recording | Optional recording settings. |
effects | Effects | Optional overlay settings. |