CreateAIAnalysisTemplate

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 analysis 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 Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: CreateAIAnalysisTemplate.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Name	No	String	Name of the video analysis template, length limited to 64 characters.
Comment	No	String	Description of the video analysis template, length limited to 256 characters.
ClassificationConfigure	No	ClassificationConfigureInfo	Intelligent Classification Task Control Parameters.
TagConfigure	No	TagConfigureInfo	Intelligent tag task control parameter.
CoverConfigure	No	CoverConfigureInfo	Intelligent Cover Task Control Parameters.
FrameTagConfigure	No	FrameTagConfigureInfo	Intelligent frame-specific tagging task control parameter.

3. Output Parameters

Parameter Name	Type	Description
Definition	Integer	Unique identifier of a video analysis template.
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 Template with All Content Analysis Tasks Enabled

This example shows you how to create a custom video content analysis template with all intelligent analysis tasks enabled.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=CreateAIAnalysisTemplate
&Name=Intelligent analysis template
&Comment=Template 3
&ClassificationConfigure.Switch=ON
&TagConfigure.Switch=ON
&CoverConfigure.Switch=NO
&FrameTagConfigure.Switch=ON
&<Common request parameters>

Output Example

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

Example2 Creating a Template to Specify an Analysis Task

This example shows you how to create a custom video content analysis template with the intelligent classification task enabled.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=CreateAIAnalysisTemplate
&Name=Intelligent analysis template
&Comment=Template 1
&ClassificationConfigure.Switch=ON
&<Common request parameters>

Output Example

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

Example3 Creating a Template to Specify Multiple Analysis Tasks

This example shows you how to create a custom video content analysis template with the intelligent classification and intelligent tag tasks enabled.

Input Example

https://mps.intl.tencentcloudapi.com/?Action=CreateAIAnalysisTemplate
&Name=Intelligent analysis template
&Comment=Template 2
&ClassificationConfigure.Switch=ON
&TagConfigure.Switch=ON
&<Common request parameters>

Output Example

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

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

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.

Error Code	Description
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.ClassifcationConfigure	Parameter value error: Intelligent classification control field parameter error.
InvalidParameterValue.Comment	Parameter error: template description.
InvalidParameterValue.CoverConfigure	Parameter value error: Intelligent cover control field parameter error.
InvalidParameterValue.Definition	Parameter error: Definition.
InvalidParameterValue.FrameTagConfigure	Parameter value error: Intelligent frame tagging control field parameter error.
InvalidParameterValue.Name	Incorrect parameter value: `Name` exceeds the length limit.
InvalidParameterValue.TagConfigure	Parameter value error: Intelligent tag control field parameter error.
LimitExceeded.TooMuchTemplate	Limit reached: the number of templates exceeds the limit.