tencent cloud

1. API Description

Domain name for API request: vm.tencentcloudapi.com.

This API is used to submit a video file or stream for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account to activate VM and adjust the business configuration.

Feature use instructions

• Go to the "CMS console - VM" to activate AMS.

• This API is a paid API. For its billing mode, see VM Pricing.

• Default API request rate limit: 20 requests/sec. When this limit is exceeded, requests for async moderation tasks (video on demand) will automatically join the queue of requests pending moderation, while an error will be reported for sync moderation tasks (video live streaming).

• Default limit on the number of concurrent moderation channels: 10. When this limit is exceeded, requests for async moderation tasks (video on demand) will automatically join the queue of requests pending moderation, while an error will be reported for sync moderation tasks (video live streaming).

API feature description

• It can automatically detect video files or streams and recognize non-compliant content in them based on the deep learning technology from the perspectives of OCR-based text recognition, object detection (such as object, advertising logo, and QR code), image recognition, and audio moderation;
• It allows you to set the callback address (Callback) to get the detection result or call the API for viewing task details to get the details of the detection result through polling. For normal video moderation tasks, if non-compliant content is contained, the captured frames will be called back within 3s, and the audio segments will be called back within the configured segment duration + 2s; for queued moderation tasks, the callback time will be equal to the sum of the callback time for normal moderation and waiting time;
• The API for viewing the moderation task list can be called to query the task queue. You can filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status;
• It can recognize various non-compliant scenarios, including vulgarity, abuse, pornography, and advertising;
• It allows you to customize moderation policies based on different business scenarios;
• You can customize blocklist/allowlist dictionaries and image libraries to filter non-compliant content of custom types (currently, only blocklist configuration is supported);
• You can customize the moderation task priority, so that when multiple tasks are queuing, the task priority will be automatically adjusted according to the configuration;
• You can submit detection tasks in batches and create up to 10 tasks at a time;

Call description for video file

• Supported video file size: < 3 GB
• Supported video file resolution: the optimal resolution is 1920x1080 (1080p). For video files of less than 300 MB in size, their resolution can be greater than 1080p; for video files of a greater size, you can call MPS to transcode them before submitting them for moderation;
• Supported video file formats: FLV, MKV, MP4, RMVB, AVI, WMV, 3GP, TS, MOV, RM, MPEG, and WMF;
• Supported video file access methods: URL (over HTTP/HTTPS) and Tencent Cloud COS;
• If you pass in the access URL of a video file, you need to limit its header file read time to 3 seconds. To ensure the stability and reliability of the video to be detected, we recommend you use Tencent Cloud COS for storage or CDN for caching;
• You can configure whether to enable audio moderation, and if it is not enabled, only the image content of video files will be moderated.

Call description for video stream

• Supported video stream duration: < 5 hours
• Supported video stream resolution: 1920x1080 (1080p). For videos with a higher resolution, you can call live transcoding to transcode them before submitting them for moderation;
• Supported video stream formats: mainstream video stream codecs such as RMTP and FLV;
• Supported video transfer protocols: HTTP, HTTPS, and RTMP;
• You can configure whether to enable audio moderation, and if it is not enabled, only the image content of video streams will be moderated.

A maximum of 500 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Creating video moderation task

This example shows you how to create a video moderation task.

Input Example

POST / HTTP/1.1
Host: vm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoModerationTask
<Common request parameters>

{
    "Type": "VIDEO",
    "Tasks": [
        {
            "DataId": "0a782332-c9db-4cf5-a66e-20d60b4ea469",
            "Input": {
                "Url": "https://test.myqcloud.com/test.mp4"
            }
        }
    ]
}

Output Example

{
  "Response": {
    "Results": [
      {
        "DataId": "0a782332-c9db-4cf5-a66e-20d60b4ea469",
        "TaskId": "c933aca1-90d2-4ab8-b045-f1b08069d76f",
        "Code": "OK",
        "Message": "Success"
      }
    ],
    "RequestId": "c933aca1-90d2-4ab8-b045-f1b08069d76f"
  }
}

Example2 Sample callback signature

If you configure Seed when creating a moderation task, we will add the signature parameter to the callback to ensure the data security.
Signature algorithm: add the X-Signature field to the returned HTTP header, whose value is the SHA256-encoded hex string of seed + body.

For example:
If your CallbackUrl is http://example.com and Seed is dedb6dcc1cb7c63fde8fa5abfd57, and the returned callback data is:

,
Then, after completing the moderation, we will pass in X-Signature with the following value in the HTTP header when calling http://example.com:
74f0ae6d1f1e4eb1ffe4162da480a812f8a4dc19fe5a52bacbcd2c862d3edcfd

Note: for the callback body format, see the API for task details query.

Input Example

POST / HTTP/1.1
Host: vm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoModerationTask
<Common request parameters>

{
    "Type": "VIDEO",
    "CallbackUrl": "https://apis.example.com/callback/video",
    "Seed": "dedb6dcc1cb7c63fde8fa5abfd57",
    "Tasks": [
        {
            "DataId": "test",
            "Input": {
                "Url": "https://test.myqcloud.com/test.mp4"
            }
        }
    ]
}

Output Example

{
  "Response": {
    "Results": [
      {
        "DataId": "test",
        "TaskId": "c933aca1-90d2-4ab8-b045-f1b08069d76f",
        "Code": "OK",
        "Message": "Success"
      }
    ],
    "RequestId": "c933aca1-90d2-4ab8-b045-f1b08069d76f"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.