ArchiveSearch

Request-body reference for POST /archive_search.

Example

{
  "class_name": "person",
  "search_type": "natural_language",
  "object_description": "person carrying a red bag",
  "alert_threshold": 80,
  "similarity": { "images": [] },
  "stream_list": ["rtsp://camera/live"],
  "start_date_time": "2025-03-17T00:00:00Z",
  "end_date_time": "2025-03-18T00:00:00Z"
}

Fields

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 search text.
face_match_type	string	Face recognition match type such as person, group, or all_faces.
face_person_id	string	Person ID for face search.
face_group_id	string	Group ID for face search.
alert_threshold	number	Optional confidence threshold.
similarity	Similarity Config	Similarity-search settings.
stream_list	string[]	Optional list of stream URLs.
start_date_time	string	Inclusive ISO start time.
end_date_time	string	Exclusive ISO end time.

Provide at least one valid search criterion: object_description, face recognition fields such as face_match_type, face_person_id, or face_group_id, or similarity.