tencent cloud

Video on Demand

DocumentationVideo on DemandServer APIsOther APIsModifyMPSTemplate

ModifyMPSTemplate

Download
Focus Mode
Font Size
Last updated: 2026-09-18 15:59:35

1. API Description

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

Modify a user-customized MPS task template.
When modifying a template, fill in MPS related parameters in MPSModifyTemplateParams in JSON format. For task parameter configuration methods, refer to the MPS task template documentation.

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: ModifyMPSTemplate.
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 the MPS template that needs to be modified.

Enumeration values:

  • AIAnalysis: intelligent analysis template
  • SmartSubtitle: intelligent subtitle template
  • SmartErase: intelligent erasure template
  • EmbedSubtitle: subtitle suppression template
MPSModifyTemplateParams No String

MPS template parameter modification. This parameter is used for passing through to the media processing service (MPS) to modify user-defined MPS task templates from the VOD side.
Currently, only the following task types support template modification in this way:

  1. Audio and video enhancement: only support filling in the content of Name, Comment, RemoveVideo, RemoveAudio, VideoTemplate, AudioTemplate, and EnhanceConfig parameters in the modify transcoding template API. 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.
  2. AI analysis: only support filling in the content of Name, Comment, ClassificationConfigure, TagConfigure, CoverConfigure, and FrameTagConfigure parameters in the modify content analysis template API. 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.
  3. Smart subtitling: only support filling in the content of Name, Comment, TranslateSwitch, VideoSrcLanguage, SubtitleFormat, SubtitleType, AsrHotWordsConfigure, TranslateDstLanguage, and ProcessType parameters in the modify smart subtitling template API. 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.
  4. Intelligent erasure: only support filling in the content of Name, Comment, EraseType, EraseSubtitleConfig, EraseWatermarkConfig, and ErasePrivacyConfig parameters in the modify intelligent erasure template API. 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.
AIAnalysisTemplate No MPSAIAnalysisTemplateForUpdate

Intelligent analysis template parameter. Valid when MPSModifyTemplateParams is empty.
SmartSubtitleTemplate No MPSSmartSubtitleTemplateForUpdate

Smart subtitle template parameter. Valid when MPSModifyTemplateParams is empty.
SmartEraseTemplate No MPSSmartEraseTemplateForUpdate

Intelligent erasure template parameter. Valid when MPSModifyTemplateParams is empty.
EmbedSubtitleTemplate No MPSEmbedSubtitleTemplateForUpdate

Subtitle suppression template parameter. Valid when MPSModifyTemplateParams is empty.

3. Output Parameters

Parameter Name Type Description
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 Modifying an MPS Audio/Video Smart Subtitle Template

Input Example

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

{
    "SubAppId": 221157,
    "TemplateType": "SmartSubtitle",
    "SmartSubtitleTemplate": {
        "Definition": 50023,
        "Name": "Template1",
        "Comment": "SmartSubtitle Template1",
        "SubtitleType": 0,
        "VideoSrcLanguage": "en",
        "SubtitleFormat": "vtt",
        "TranslateSwitch": "OFF",
        "ProcessType": 0
    }
}

Output Example

{
    "Response": {
        "RequestId": "0d54e984-91ba-4b2a-abb3-f417303bfd3a"
    }
}

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
InternalError Internal error.
InvalidParameterValue Parameter value error.
ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.
Previous Topic: DescribeMPSTemplatesNext Topic: ProcessMediaByMPS

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback

Search
    Enter keywords to search documentation