archive_search

Search archived detections and indexed results.

• Method: POST
• Path: /archive_search

Request Body

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

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 archive 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	Optional confidence threshold for the search criteria.
similarity	Similarity Config	Similarity-search configuration.
stream_list	string[]	Optional list of stream URLs to search.
start_date_time	string	Optional inclusive start time in ISO format.
end_date_time	string	Optional exclusive end time in ISO format.

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": {
    "results": []
  }
}

Field	Type	Description
data.results	Search Result[]	Matching archive results.