Request Rules

Shared request rules used across the REST API.

Common Rules

• Use Content-Type: application/json for POST requests.
• Provide ISO date-time strings for date and time fields such as start_date_time, end_date_time, and video_start_local_time.
• Use full RTSP URLs for stream_url fields.
• For live-search updates, use search_id: -1 to target all active searches.
• Search requests must include at least one valid search criterion, such as object_description, face recognition fields, or similarity.

Common Value Ranges

Field	Rule
frame_rate	Minimum 1
alert_threshold in live_search	Greater than 0 and less than 100
duration_seconds	0 or greater
alert_seconds	Minimum 0.1 when used
reset_seconds	Minimum 0.1 when used