Skip to main content

Detection

A detection record returned by image, video, and stream-processing endpoints.

Example

{
"region": "Front Entrance",
"class_name": "person",
"stream_url": "rtsp://camera/live",
"stream_name": "Warehouse Camera 01",
"time": "2025-03-17T22:27:33Z",
"frame_num": 875,
"condition": {
"type": "count_greater_than",
"count": 0,
"objects": []
},
"objects": []
}

Fields

FieldTypeDescription
regionstringRegion name where the detection occurred.
class_namestringDetected class when class-based detection is used.
objectsDetection Object[]Object matches returned for image processing results.
stream_urlstringStream URL for stream or video detections.
stream_namestringStream or job name when provided by the server.
timestringDetection time in ISO format for stream or video detections.
frame_numnumberFrame number for stream or video detections.
eventstringEvent label returned with stream or video detections.
object_descriptionstringPrimary object description when provided by the server.
conditionDetection ConditionTriggering condition for stream or video detections.
result_idstringSearch result identifier when available.
imagestringBase64-encoded detection image when provided.