Overview
Menu

CreateAIRecognitionTemplate

Last updated: 2026-08-14 16:33:35Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to create a user-defined Content Recognition template. Up to 50 templates can be created.

A maximum of 10 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateAIRecognitionTemplate.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
NameNoStringVideo content recognition template name, length limited to 64 characters.
CommentNoStringVideo Content Recognition template description, length limited to 256 characters.
FaceConfigureNoFaceConfigureInfoFace Recognition Control Parameter.
OcrFullTextConfigureNoOcrFullTextConfigureInfoFull Text Recognition Control Parameter.
OcrWordsConfigureNoOcrWordsConfigureInfoText keyword recognition control.
AsrFullTextConfigureNoAsrFullTextConfigureInfoSpeech Full-text Recognition Control Parameter.
AsrWordsConfigureNoAsrWordsConfigureInfoVoice keyword recognition control parameters.
TranslateConfigureNoTranslateConfigureInfoVoice translation control parameters.

3. Output Parameters

Parameter NameTypeDescription
DefinitionIntegerUnique identifier of a video content recognition template.
RequestIdStringThe 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 Template for Multiple Video Content Recognition Tasks

This example shows you how to create a custom video recognition template with face recognition enabled. The default face library is used, and the face recognition filter score is 90.

Input Example

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

{
    "Comment": "Template 2",
    "FaceConfigure": {
        "Switch": "ON",
        "Score": "90",
        "FaceLibrary": "Default"
    },
    "Name": "Intelligent Identification Template"
}

Output Example

{
    "Response": {
        "Definition": 31,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example2 Creating a Template for Multiple Recognition Tasks, with the Frame Extraction Interval Specified

This example shows you how to create a custom video recognition template with face recognition enabled. The default and custom face libraries are used, and the face recognition filter score is 90.

Input Example

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

{
    "Comment": "Template 3",
    "FaceConfigure": {
        "Switch": "ON",
        "FaceLibrary": "All"
    },
    "Name": "Intelligent Identification Template"
}

Output Example

{
    "Response": {
        "Definition": 32,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example3 Creating a Speech Translation Template

This example shows you how to create a speech translation template.

Input Example

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

{
    "Name": "recog",
    "TranslateConfigure": {
        "Switch": "ON",
        "SourceLanguage": "en",
        "DestinationLanguage": "zh"
    }
}

Output Example

{
    "Response": {
        "Definition": 278654,
        "RequestId": "62cca75c-7dd3-4819-ad9d-13b48a4b4018"
    }
}

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 CodeDescription
FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
InternalErrorInternal error.
InvalidParameterParameter error.
InvalidParameterValueIncorrect parameter value.
InvalidParameterValue.CommentParameter error: template description.
InvalidParameterValue.DefaultLibraryLabelSetParameter value error: the filter tag of the default human face library is invalid.
InvalidParameterValue.DestinationLanguageA DestinationLanguage parameter error occurs.
InvalidParameterValue.FaceLibraryParameter value error: the face library parameter is invalid.
InvalidParameterValue.FaceScoreParameter value error: the Face Score parameter value is invalid.
InvalidParameterValue.LabelSetIncorrect parameter value: invalid LabelSet value.
InvalidParameterValue.NameIncorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.ObjectLibraryParameter value error: the object library parameter is invalid.
InvalidParameterValue.SourceLanguageA SourceLanguage parameter error occurs.
InvalidParameterValue.SubtitleFormatParameter value error: the SubtitleFormat parameter is invalid.
InvalidParameterValue.SwitchIncorrect parameter value: invalid Switch value.
InvalidParameterValue.UserDefineLibraryLabelSetParameter value error: the filter tag of the custom face library is invalid.
LimitExceeded.TooMuchTemplateLimit reached: the number of templates exceeds the limit.