Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create a custom template for partial features of the ProcessMediaByMPS API.
When creating a template, fill in MPS related parameters in JSON format into the MPSCreateTemplateParams parameter. For specific task parameter configuration methods, refer to the MPS task template related documentation.
Currently supported MPS features for creating custom templates:
Template for tasks created using this method:
Template management is still completed in the VOD platform.
- The feature is currently in beta test. If needed, you can contact us for support.
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: CreateMPSTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | Yes | Integer | VOD application ID. |
| TemplateType | Yes | String | Type of MPS template to create. Values: |
| MPSCreateTemplateParams | No | String | MPS template creation parameter. This parameter is used to pass through to the media processing service (MPS) to create user-defined MPS task templates from the VOD side.
Currently, only the above parameters can be configured in the template. Other parameters are not required. If other parameters are included, the system will automatically ignore them. The above pass-through parameters are represented in JSON format. |
| AIAnalysisTemplate | No | MPSAIAnalysisTemplate | Intelligent analysis template parameter. Valid when MPSCreateTemplateParams is empty. |
| SmartSubtitleTemplate | No | MPSSmartSubtitleTemplate | Smart subtitle template parameter. Valid when MPSCreateTemplateParams is empty. |
| SmartEraseTemplate | No | MPSSmartEraseTemplate | Intelligent erasure template parameter. Valid when MPSCreateTemplateParams is empty. |
| EmbedSubtitleTemplate | No | MPSEmbedSubtitleTemplate | Subtitle suppression template parameter. Valid when MPSCreateTemplateParams is empty. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique identifier of an MPS task template. This template is independent of templates created directly in Media Processing Service (MPS). |
| 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. |
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMPSTemplate
<Common request parameters>
{
"SubAppId": 260085028,
"TemplateType": "AIAnalysis",
"AIAnalysisTemplate": {
"Name": "AI Analysis"
"Comment": "Intelligent Analysis Template",
"ClassificationConfigure": {
"Switch": "ON"
},
"TagConfigure": {
"Switch": "ON"
},
"CoverConfigure": {
"Switch": "ON"
},
"FrameTagConfigure": {
"Switch": "ON"
},
"SplitConfigure": {
"Switch": "ON"
},
"HighlightConfigure": {
"Switch": "ON"
},
"OpeningAndEndingConfigure": {
"Switch": "ON"
}
}
}{
"Response": {
"Definition": 30186,
"RequestId": "c6d3e3f5-1082-4053-89e0-4172b456c2e1"
}
}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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded.TooMuchTemplate | Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category). |
文档反馈