AI Guardrails:Asynchronous detection

Billing

Charges apply per moderation scenario. For multi-scenario detection, fees accumulate — each scenario is charged by multiplying the number of moderated video frames by the unit price for that scenario. If audio detection is also enabled, an additional fee applies: video duration × unit price for audio violation detection.

Detection objects

Moderation supports video files and video streams:

• Video files: Submit a sequence of video frame images, or provide a video URL.

• Video streams: Provide a stream URL using a supported protocol.

Retrieve results

Asynchronous moderation results are not returned in the response. Use one of two methods to retrieve them:

• Callback (recommended): Include the callback parameter in the request. AI Guardrails pushes results to your endpoint automatically when detection is complete.

• Polling: Omit the callback parameter, then call /green/video/results periodically to retrieve results. Query at least 30 seconds after submitting the task. Results are retained for up to 4 hours.

Moderation results are retained for up to 1 hour.

Video requirements

Video files:

• URL protocol: HTTP or HTTPS

• Supported formats: AVI, FLV, MP4, MPG, ASF, WMV, MOV, WMA, RMVB, RM, FLASH, TS

• Maximum file size: 200 MB. For files larger than 200 MB, segment the video before submitting. To increase the size limit, contact technical support via DingTalk Group (group number: 35573806).

• Use a stable storage service. Object Storage Service (OSS) is recommended.

Video streams:

• Supported protocols: RTMP, HLS, HTTP-FLV, RTSP

• Maximum stream duration per task: 24 hours. The task ends automatically after 24 hours.

Detection scenarios

For audio detection, use the audioScenes parameter with value antispam. Audio detection is supported only by this asynchronous operation and requires the url parameter (not frames). Result labels: Normal, Spam, Ad, Political, Terrorism, Abuse, Pornographic, Flooding, Contraband, Custom.

The default language for audio detection is Chinese. To detect English audio content, contact your account manager.

QPS limits

To increase the concurrent task limit, contact your business manager.

If you do not need real-time moderation, enable offline moderation. In offline moderation mode, the system starts processing within 24 hours after you submit the task.

Request parameters

Callback notifications

When callback is set, AI Guardrails sends a POST request to the callback URL with two parameters:

• `checksum`: A signature string in UID + Seed + Content format, generated using the algorithm specified by cryptType. UID must be your Alibaba Cloud account ID — not a RAM user ID. To verify the callback, generate the same string on your server and compare it to the received checksum. Obtain your account ID from the Alibaba Cloud Management Console.

• `content`: A JSON-formatted string containing moderation results. The structure matches the success response from the result query operation.

AI Guardrails retries failed callback deliveries up to 16 times. After 16 attempts, the callback is abandoned. If callbacks are not received, check the status of the callback URL.

Return HTTP 200 from your server to confirm successful receipt.

Response parameters

Examples

Request — submit video frame images

POST http(s)://[Endpoint]/green/video/asyncscan
&<Common request parameters>

{
    "scenes": ["porn"],
    "tasks": [
        {
            "dataId": "videoId****",
            "frames": [
                {"offset": 10, "url": "http://www.aliyundoc.com/0B860000586C0A0300038A0460000"},
                {"offset": 20, "url": "http://www.aliyundoc.com/0B860000586C0A0300038A0460001"},
                {"offset": 30, "url": "http://www.aliyundoc.com/0B860000586C0A0300038A0460002"},
                {"offset": 40, "url": "http://www.aliyundoc.com/0B860000586C0A0300038A0460003"},
                {"offset": 50, "url": "http://www.aliyundoc.com/0B860000586C0A0300038A0460003"},
                {"offset": 60, "url": "http://www.aliyundoc.com/0B860000586C0A0300038A046000x"}
            ]
        }
    ]
}

Request — submit a video file with audio detection

POST http(s)://[Endpoint]/green/video/asyncscan
&<Common request parameters>

{
    "scenes": ["porn"],
    "audioScenes": ["antispam"],
    "tasks": [
        {
            "dataId": "videoId****",
            "url": "http://www.aliyundoc.com/a.mp4",
            "interval": 1,
            "maxFrames": 200
        }
    ]
}

Request — submit a live video stream

POST http(s)://[Endpoint]/green/video/asyncscan
&<Common request parameters>

{
    "scenes": ["porn"],
    "live": true,
    "tasks": [
        {
            "dataId": "videoId****",
            "url": "http://www.aliyundoc.com/a.flv",
            "interval": 1,
            "maxFrames": 200
        }
    ]
}

Response

{
    "code": 200,
    "msg": "OK",
    "requestId": "requestID****",
    "data": [
        {
            "dataId": "videoId****",
            "taskId": "taskId****"
        }
    ]
}

Billing

This operation is free of charge.

Query timing

Query at least 30 seconds after submitting an async moderation request. Results are retained for up to 4 hours; after that, they are deleted.

For live stream tasks, a response code of 280 means detection is in progress. A code of 200 means detection is complete. When a task is in progress, results reflect findings from the start of detection to the current time.

QPS limits

Maximum 50 calls per second per account.

Request parameters

Response parameters

Examples

Request

POST http(s)://[Endpoint]/green/video/results
&<Common request parameters>

[
    "taskId****",
    "taskId****"
]

Response — video frames only

{
    "code": 200,
    "msg": "OK",
    "requestId": "requestID****",
    "data": [
        {
            "code": 200,
            "msg": "OK",
            "dataId": "videoId****",
            "taskId": "taskId****",
            "results": [
                {
                    "label": "porn",
                    "rate": 99.2,
                    "scene": "porn",
                    "suggestion": "block"
                }
            ]
        }
    ]
}

Response — video frames and audio

{
    "code": 200,
    "msg": "OK",
    "requestId": "requestID****",
    "data": [
        {
            "code": 200,
            "msg": "OK",
            "dataId": "videoId****",
            "taskId": "taskId****",
            "results": [
                {
                    "label": "porn",
                    "rate": 99.2,
                    "scene": "porn",
                    "suggestion": "block"
                }
            ],
            "audioScanResults": [
                {
                    "scene": "antispam",
                    "label": "customized",
                    "suggestion": "block",
                    "rate": 99.91,
                    "details": [
                        {
                            "startTime": 0,
                            "endTime": 24,
                            "text": "Computer",
                            "label": "customized"
                        },
                        {
                            "startTime": 24,
                            "endTime": 60,
                            "text": "Computer",
                            "label": "normal"
                        }
                    ]
                }
            ]
        }
    ]
}