AI Guardrails:/green/image/asyncscan and /green/image/results

Billing

Charged per call. For pricing details, see the Content Moderation billing documentation.

Response timeout

The maximum response time for a synchronous moderation request is 6 seconds. If moderation is not completed within 6 seconds, a timeout error is returned. If you do not require results in real time, use asynchronous moderation requests. When calling synchronous moderation operations, set the timeout period to 6 seconds.

Moderation scenarios

You can specify multiple scenarios in a single request. When you do, each scenario is billed separately.

QPS limit

50 calls per second per account. Exceeding this limit triggers throttling.

Image requirements

• URL format: HTTP or HTTPS

• Supported formats: PNG, JPG, JPEG, BMP, GIF, WEBP

• Maximum size: 20 MB

• Download timeout: 3 seconds. Images that cannot be downloaded within 3 seconds return a timeout error.

• Minimum resolution: 256 × 256 pixels (recommended for best moderation accuracy)

• Storage: Use Object Storage Service (OSS) or Content Delivery Network (CDN) for reliable image availability.

Retrieving results

Moderation results are retained for up to 1 hour (or 24 hours if offline is set to true). Two retrieval options:

• Callback notification: Set the callback parameter when submitting tasks. Content Moderation POSTs results to your URL as they complete.

• Polling: Call /green/image/results after submitting tasks. Query at 30-second intervals.

Request parameters

Response parameters

Callback notification format

When Content Moderation pushes results to your callback URL, it includes two parameters:

• checksum: A SHA-256 hash of UID + Seed + Content, where UID is your Alibaba Cloud account ID. Verify this value on your server to detect tampering.

• content: A JSON-encoded string. Parse it using the same format as the /green/image/results success response.

If your server returns HTTP 200, the notification is considered delivered. Otherwise, Content Moderation retries the push up to 16 times. After 16 failed attempts, the notification is dropped — check your callback URL if you stop receiving results.

Example

Request:

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

{
    "scenes": ["porn"],
    "tasks": [
        {
            "dataId": "test4lNSMdggA0c56MMvfYoh4e-1mwxpx",
            "url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
        }
    ]
}

Response:

{
    "code": 200,
    "msg": "OK",
    "requestId": "95AD868A-F5D2-4AEA-96D4-E0273B8E074C",
    "data": [
        {
            "code": 200,
            "msg": "OK",
            "dataId": "test4lNSMdggA0c56MMvfYoh4e-1mwxpx",
            "taskId": "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695",
            "url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
        }
    ]
}

Billing

Free of charge.

Usage notes

• Query results 30 seconds after submitting a task.

• Task IDs expire based on the offline setting:

  • offline=false (default): task ID valid for 1 hour

  • offline=true: task ID valid for 24 hours

QPS limit

50 calls per second per account. Exceeding this limit triggers throttling.

Request parameters

Response parameters

Example

Request:

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

["fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695"]

Response:

{
    "msg": "OK",
    "code": 200,
    "requestId": "69B41AE8-1234-1234-1234-12D395695D2D",
    "data": [
        {
            "msg": "OK",
            "code": 200,
            "dataId": "test4lNSMdggA0c56MMvfYoh4e-1mwxpx",
            "taskId": "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695",
            "url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png",
            "extras": {},
            "results": [
                {
                    "scene": "porn",
                    "label": "sexy",
                    "suggestion": "block",
                    "rate": 99.63
                },
                {
                    "scene": "terrorism",
                    "label": "politics",
                    "suggestion": "block",
                    "rate": 91.54,
                    "sfaceData": [
                        {
                            "x": 49,
                            "y": 39,
                            "w": 97,
                            "h": 131,
                            "faces": [
                                {
                                    "id": "AliFace_0001234",
                                    "name": "Hit name",
                                    "rate": 91.54
                                }
                            ]
                        }
                    ]
                },
                {
                    "scene": "ad",
                    "label": "ad",
                    "suggestion": "block",
                    "rate": 99.91,
                    "extras": {
                        "qrcodes": "http://www.aliyundoc.com/0.ZZOliO",
                        "npx": "72.01",
                        "hitCustomLibCode": "8012345000",
                        "hitCustomLibName": "Name of the custom image library",
                        "hitLibInfo": [
                            {
                                "context": "Hit text",
                                "libCode": "123456",
                                "libName": "Name of the custom text library"
                            }
                        ]
                    },
                    "programCodeData": [
                        {
                            "x": 11.0,
                            "y": 0.0,
                            "w": 402.0,
                            "h": 413.0
                        }
                    ],
                    "frames": [
                        {
                            "rate": 89.85,
                            "url": "http://www.aliyundoc.com/xxx-0.jpg"
                        },
                        {
                            "rate": 68.06,
                            "url": "http://www.aliyundoc.com/xxx-1.jpg"
                        }
                    ]
                },
                {
                    "scene": "live",
                    "label": "drug",
                    "suggestion": "block",
                    "rate": 99.91
                },
                {
                    "scene": "qrcode",
                    "label": "qrcode",
                    "suggestion": "review",
                    "rate": 99.91,
                    "qrcodeData": [
                        "http://www.aliyundoc.com/01ZZOliO"
                    ]
                },
                {
                    "scene": "logo",
                    "label": "TV",
                    "suggestion": "block",
                    "rate": 99.9,
                    "logoData": [
                        {
                            "name": "xxx TV",
                            "type": "TV",
                            "x": 140,
                            "y": 68,
                            "w": 106,
                            "h": 106
                        }
                    ]
                }
            ]
        }
    ]
}