tencent cloud

All product documents
Media Processing Service
DocumentationMedia Processing ServiceAPI DocumentationMedia AI Template APIsDescribeSmartSubtitleTemplates
DescribeSmartSubtitleTemplates
Download PDF
Last updated: 2025-03-28 15:37:18
DescribeSmartSubtitleTemplates
Last updated: 2025-03-28 15:37:18
Download PDF

1. API Description

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

This API is used to obtain the list of smart subtitle templates based on template unique identifier. The returned result includes all matching user-defined smart subtitle templates and system preset smart subtitle templates.

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: DescribeSmartSubtitleTemplates.
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.
Definitions.N No Array of Integer Condition for filtering smart subtitle templates by unique identifier. The array can contain up to 10 unique identifiers.
Offset No Integer Paging offset. Default value: 0.
Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
Type No String Condition for filtering templates by type. If this field is not specified, all templates are returned. Valid values:
* Preset: system preset template
* Custom: user-defined template
Name No String Condition for filtering smart subtitle templates by ID. Length limit: 64 characters.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of records that meet filter conditions.
SmartSubtitleTemplateSet Array of SmartSubtitleTemplateItem List of smart subtitle template details.
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 Querying a Smart Subtitle Template

Input Example

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

{}

Output Example

{
    "Response": {
        "RequestId": "f89a1f41-1a26-4cda-9be1-2747cb44a045",
        "SmartSubtitleTemplateSet": [
            {
                "AliasName": "Generate_Chinese_And_English_Subtitle_For_English_Video",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-02-11T15:41:29+08:00",
                "Definition": 212,
                "Name": "English source video—Generate English and Chinese subtitles",
                "SubtitleFormat": "vtt",
                "SubtitleType": 2,
                "TranslateDstLanguage": "zh",
                "TranslateSwitch": "ON",
                "Type": "Preset",
                "UpdateTime": "2025-02-11T15:41:29+08:00",
                "VideoSrcLanguage": "en"
            },
            {
                "AliasName": "Generate_Chinese_Subtitle_For_English_Video",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-02-11T15:41:29+08:00",
                "Definition": 211,
                "Name": "English source video—Generate Chinese subtitles",
                "SubtitleFormat": "vtt",
                "SubtitleType": 1,
                "TranslateDstLanguage": "zh",
                "TranslateSwitch": "ON",
                "Type": "Preset",
                "UpdateTime": "2025-02-11T15:41:29+08:00",
                "VideoSrcLanguage": "en"
            },
            {
                "AliasName": "Generate_English_Subtitle_For_English_Video",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-02-11T15:41:29+08:00",
                "Definition": 200,
                "Name": "English source video—Generate English subtitles",
                "SubtitleFormat": "vtt",
                "SubtitleType": 0,
                "TranslateDstLanguage": "en",
                "TranslateSwitch": "OFF",
                "Type": "Preset",
                "UpdateTime": "2025-02-11T15:41:29+08:00",
                "VideoSrcLanguage": "en"
            },
            {
                "AliasName": "Generate_Chinese_And_English_Subtitle_For_Chinese_Video",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-02-11T15:41:29+08:00",
                "Definition": 122,
                "Name": "Chinese source video—Generate English and Chinese subtitles",
                "SubtitleFormat": "vtt",
                "SubtitleType": 2,
                "TranslateDstLanguage": "en",
                "TranslateSwitch": "ON",
                "Type": "Preset",
                "UpdateTime": "2025-02-11T15:41:29+08:00",
                "VideoSrcLanguage": "zh"
            },
            {
                "AliasName": "Generate_English_Subtitle_For_Chinese_Video",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-02-11T15:41:29+08:00",
                "Definition": 121,
                "Name": "Chinese source video—Generate English subtitles",
                "SubtitleFormat": "vtt",
                "SubtitleType": 1,
                "TranslateDstLanguage": "en",
                "TranslateSwitch": "ON",
                "Type": "Preset",
                "UpdateTime": "2025-02-11T15:41:29+08:00",
                "VideoSrcLanguage": "zh"
            },
            {
                "AliasName": "Generate_Chinese_Subtitle_For_Chinese_Video",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-02-11T15:41:29+08:00",
                "Definition": 100,
                "Name": "Chinese source video—Generate Chinese subtitles",
                "SubtitleFormat": "vtt",
                "SubtitleType": 0,
                "TranslateDstLanguage": "en",
                "TranslateSwitch": "OFF",
                "Type": "Preset",
                "UpdateTime": "2025-02-11T15:41:29+08:00",
                "VideoSrcLanguage": "zh"
            },
            {
                "AliasName": "",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-03-04T18:18:35+08:00",
                "Definition": 202226,
                "Name": "aaaaa",
                "SubtitleFormat": "",
                "SubtitleType": 0,
                "TranslateDstLanguage": "",
                "TranslateSwitch": "OFF",
                "Type": "Custom",
                "UpdateTime": "2025-03-04T18:18:35+08:00",
                "VideoSrcLanguage": "zh"
            },
            {
                "AliasName": "",
                "AsrHotWordsConfigure": {
                    "LibraryId": "hwd-390af315ba0c31545156",
                    "Switch": "ON"
                },
                "AsrHotWordsLibraryName": "ValidName",
                "Comment": "",
                "CreateTime": "2025-02-21T16:26:37+08:00",
                "Definition": 201309,
                "Name": "0221",
                "SubtitleFormat": "vtt",
                "SubtitleType": 0,
                "TranslateDstLanguage": "",
                "TranslateSwitch": "OFF",
                "Type": "Custom",
                "UpdateTime": "2025-02-21T16:26:37+08:00",
                "VideoSrcLanguage": "zh"
            },
            {
                "AliasName": "",
                "AsrHotWordsConfigure": {
                    "LibraryId": "",
                    "Switch": "OFF"
                },
                "AsrHotWordsLibraryName": "",
                "Comment": "",
                "CreateTime": "2025-02-21T16:13:06+08:00",
                "Definition": 201308,
                "Name": "0221",
                "SubtitleFormat": "vtt",
                "SubtitleType": 0,
                "TranslateDstLanguage": "",
                "TranslateSwitch": "OFF",
                "Type": "Custom",
                "UpdateTime": "2025-02-21T16:13:06+08:00",
                "VideoSrcLanguage": "zh"
            },
            {
                "AliasName": "",
                "AsrHotWordsConfigure": {
                    "LibraryId": "hwd-f1d930ebc6d9a7d910",
                    "Switch": "ON"
                },
                "AsrHotWordsLibraryName": "HotwordsName1",
                "Comment": "",
                "CreateTime": "2025-02-21T16:08:45+08:00",
                "Definition": 201307,
                "Name": "0221",
                "SubtitleFormat": "",
                "SubtitleType": 0,
                "TranslateDstLanguage": "",
                "TranslateSwitch": "OFF",
                "Type": "Custom",
                "UpdateTime": "2025-02-21T17:50:15+08:00",
                "VideoSrcLanguage": "zh"
            }
        ],
        "TotalCount": 21
    }
}

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.InvalidMpsUser Operation failed: unauthorized MPS user.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue.Definitions Parameter error: Definitions.
InvalidParameterValue.Limit Parameter error: Limit.
ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon