Skip to main content

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

FieldTypeDescription
class_namestringOptional class filter.
search_typestringSearch strategy.
object_descriptionstringNatural-language search text.
face_match_typestringFace recognition match type.
face_person_idstringPerson ID for face search.
face_group_idstringGroup ID for face search.
alert_thresholdnumberOptional confidence threshold.
similaritySimilarity ConfigSimilarity-search settings.
stream_liststring[]Optional list of stream URLs.
start_date_timestringInclusive ISO start time.
end_date_timestringExclusive ISO end time.