Release Notes
Announcements
Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to moderate an image stored in VOD (detect pornographic and terrorist content).>
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. |
| FileId | Yes | String | The unique ID of the media file. For this API to work, the file must be an image. |
| Definition | Yes | Integer | The image moderation template ID. Valid values: Porn and Terror. |
| SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
| Parameter Name | Type | Description |
|---|---|---|
| ReviewResultSet | Array of ContentReviewResult | The image moderation result. Note: This parameter is no longer used. Please use MediaReviewResult instead. |
| MediaReviewResult | ReviewImageResult | The image moderation result. Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
Initiate the image review task using template ID 10.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReviewImage
<Public Request Parameter>
{
"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"
},
"ReviewResultSet": [
{
"Type": "Porn.Image",
"PornImageResult": {
"Confidence": 99,
"Suggestion": "block",
"Label": "porn"
},
"TerrorismImageResult": null,
"PoliticalImageResult": null,
"PornOcrResult": null,
"TerrorismOcrResult": null,
"PoliticalOcrResult": null
}
]
}
}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 | Incorrect parameter value. |
| LimitExceeded | Quota limit is exceeded. |
| RequestLimitExceeded | Too many requests. |
| 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