live_search

Start a live search across active streams.

• Method: POST
• Path: /live_search

Request Body

{
  "class_name": "person",
  "search_type": "face_recognition",
  "object_description": null,
  "face_match_type": "group",
  "face_person_id": null,
  "face_group_id": "employees",
  "alert_threshold": 80,
  "similarity": null,
  "stream_list": ["rtsp://camera/live"],
  "duration_seconds": 600,
  "notification": {
    "include_image": true,
    "phone_number": "+15551234567"
  }
}

Field	Type	Description
class_name	string	Optional object class filter such as person, vehicle, bag, animal, or unknown.
search_type	string	Search strategy. Common values are class_name, natural_language, face_recognition, and similarity.
object_description	string	Natural-language query for the live search.
face_match_type	string	Face recognition match type such as person, group, or all_faces.
face_person_id	string	Person ID for person-specific face recognition search.
face_group_id	string	Group ID for group-based face recognition search.
alert_threshold	number	Required threshold for live-search alerts. Use a value greater than 0 and less than 100.
similarity	Similarity Config	Similarity-search configuration.
stream_list	string[]	Optional list of stream URLs to search.
duration_seconds	number	Optional search duration in seconds.
notification	Notification	Optional notification settings for live-search alerts.

Provide at least one valid search criterion:

• object_description
• face recognition fields such as face_match_type, face_person_id, or face_group_id
• similarity

Success Response

{
  "success": true,
  "message": null,
  "data": {
    "search_id": 42
  }
}

Field	Type	Description
data.search_id	number	Identifier for the live-search task.