AI Video Analytics Box — API Reference

Alarm push API

URL: A callback URL configured by the integrating party.

Method: POST

Content-Type: application/json

Request body

The request body is a JSON object with these fields:

Top-level fields

results array fields

Each element of the results array includes:

coordinates object fields

The coordinates object includes:

Sample request

{ 
    "taskNo": "123456", 
    "imageSource": "relative path of the image file", 
    "imageBase64": "base64-encoded image", 
    "videoSource": "", 
    "cameraNo": "CAM001", 
    "cameraName": "entrance camera", 
    "position": "south gate", 
    "results": [ 
        { 
            "algorithmId": "001", 
            "algorithmName": "person detection", 
            "category": "person", 
            "confidence": 0.92, 
            "coordinates": { 
            "x1": 100, 
            "y1": 50, 
            "x2": 300, 
            "y2": 500 
        }, 
        "trackId": 2
        } 
    ] 
}

Response

The server should return an HTTP status code to indicate the callback result:

Notes

For the media files, imageSource and videoSourcemust be reachable by the receiving system.

Every confidence value is a floating-point number from 0 to 1 .

trackId distinguishes an object tracked across frames or events.