Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to initiate review tasks for image files in on-demand video, including offensive, unsafe, and inappropriate content.
<
Supported image file size: file < 5M;
<Supported image file resolution: recommended resolution above 256x256, otherwise review effectiveness may be affected;
<Supported image file formats: PNG, JPG, JPEG, BMP, GIF, WEBP.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ReviewImage. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Definition | Yes | Integer | Image content review template ID. Valid values: |
| FileId | No | String | Media file ID, which is the globally unique identifier of the file on VOD. This interface requires that the media file must be in an image format. Either FileId or MediaStoragePath must be provided. |
| MediaStoragePath | No | String | Storage path of the media. Only sub-apps in FileID + Path mode can initiate tasks through MediaStoragePath. Either FileId or MediaStoragePath must be provided. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD services after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications, whether in the default application or a newly created application. |
| Parameter Name | Type | Description |
|---|---|---|
| MediaReviewResult | ReviewImageResult | Image moderation job result. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Use template ID 10 to initiate an image moderation task.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReviewImage
<Common request parameters>
{
"Definition": 10,
"FileId": "5285485487985271487"
}{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"MediaReviewResult": {
"Suggestion": "block",
"Label": "Porn",
"Form": "Image",
"SegmentSet": [
{
"Confidence": 99,
"Suggestion": "block",
"Label": "Porn",
"SubLabel": "SexyBehavior",
"Form": "Image",
"AreaCoordSet": [],
"Text": "",
"KeywordSet": []
}
],
"SegmentSetFileUrl": "xxx/a.mp4",
"SegmentSetFileUrlExpireTime": "2020-09-07T00:00:00+08:00"
}
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| FailedOperation.MediaType | Operation failed: unsupported media type. |
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded | The quota limit is exceeded. |
| RequestLimitExceeded | Number of requests exceeds the frequency limit. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback