All Products
Search
Document Center

AI Guardrails:/green/video/cancelscan

Last Updated:Mar 31, 2026

Stops one or more video stream moderation tasks that are in progress.

Operation description

Call this operation to stop asynchronous video stream moderation tasks after you submit them. This operation applies only to video stream moderation tasks — it cannot stop video file moderation tasks.

For request construction details, see Request structure or use the SDK overview to work with an existing HTTP client.

Billing: Free of charge.

QPS limits

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

Request parameters

Include all common parameters required by Content Moderation API requests.

The request body is a JSON array of task IDs.

ParameterTypeRequiredExampleDescription
bodyJSONArrayYes["taskId1","taskId2"]The IDs of the moderation tasks to stop. Maximum: 100 task IDs.

Response elements

The data field in the response body is a JSON array. Each element contains the following fields.

ParameterTypeExampleDescription
codeInteger200The HTTP status code. For details, see Common error codes.
msgStringOKThe status message for the request.
taskIdStringtaskId1The ID of the moderation task, returned by the AI Guardrails server to uniquely identify the moderation task.

Examples

Request

http(s)://[Endpoint]/green/video/cancelscan
&<Common request parameters>
[
  "taskId1",
  "taskId2"
]

Response

{
    "code": 200,
    "msg": "OK",
    "requestId": "AD87F1D1-A675-4F82-8D67-ED43B6FFA876",
    "data": [
        {
            "code": 200,
            "msg": "ok",
            "taskId": "taskId1"
        },
        {
            "code": 200,
            "msg": "ok",
            "taskId": "taskId2"
        }
    ]
}