tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateReviewTemplate

Last updated: 2024-03-27 16:09:22

    1. API Description

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

    This API is used to create a custom moderation template. Up to 50 templates can be created in total.

    The templates can only be used by the APIs ReviewAudioVideo and ReviewImage.

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

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: CreateReviewTemplate.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Labels.N Yes Array of String The violation labels to use. Valid values:
  • Porn: Pornographic content
  • Terror: Terrorist content
  • Moan: Moaning
    		•
    SubAppId No String 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.
    Name No String
    Comment No String

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer
    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.

    4. Example

    Example1 Creating a moderation template with multiple violation labels

    This example shows you how to create a moderation template that detects pornographic content, terrorist content, and ads.

    Input Example

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

{
    "Name": "test",
    "Comment": "Detect pornographic, terrorist, and promotional content.",
    "Labels": [
        "Porn",
        "Terror",
        "Ad"
    ]
}

    Output Example

    {
    "Response": {
        "Definition": 20123,
        "RequestId": "88aee3e9-2qd3-4151-9d4b-4390a45228a9"
    }
}

    5. Developer Resources

    SDK

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

    Command Line Interface

    6. Error Code

    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.
    InternalError Internal error.
    InternalError.GenDefinition Internal error: failed to generate template ID.
    InvalidParameter.Labels Parameter error: Invalid label.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Comment Invalid parameter: template description.
    InvalidParameterValue.Labels Parameter error: Invalid label.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    LimitExceeded Quota limit is exceeded.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy