DescribeSubtitleEmbedTemplates

Last updated: 2026-04-08 17:39:08Download PDF

1. API Description

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

This API is used to retrieve the subtitle suppression template details list based on template unique identifier. The returned results include all eligible user-customized subtitle suppression templates and system preset subtitle suppression 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: DescribeSubtitleEmbedTemplates.
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	Unique identifiers of intelligent caption templates for filtering. The array can contain up to 100 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	Filtering condition for the template type. Leave it blank to return all. Valid values: Preset: system preset template; Custom: user-defined template.
Name	No	String	Condition for filtering subtitle suppression templates by ID. Length limit: 64 characters.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of records that meet filter conditions.
SubtitleEmbedTemplateSet	Array of SubtitleEmbedTemplateItem	List of subtitle suppression 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 Retrieve subtitle suppression template list

Input Example

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

{}

Output Example

{
    "Response": {
        "SubtitleEmbedTemplateSet": [
            {
                "AliasName": "AutoFont-Background-LargeSize",
                "Comment": "",
                "CreateTime": "2026-03-17T15:06:16+08:00",
                "Definition": 4,
"Name": "Auto Font-Subtitles with Background"
                "SubtitleEmbedConfig": {
                    "CosInputInfo": {
                        "Bucket": "",
                        "Object": "",
                        "Region": ""
                    },
                    "FontAlpha": 1,
                    "FontColor": "0xFFFFFF",
                    "FontPath": "",
                    "FontSize": 10,
                    "FontSizeUnit": 1,
                    "FontType": "auto",
                    "PosX": 0,
                    "PosXUnit": 1,
                    "PosY": 13,
                    "PosYUnit": 1,
                    "SampleHeight": 0,
                    "SampleWidth": 0,
                    "SubtitleBoardConfig": {
                        "BoardAlpha": 1,
                        "BoardColor": "0x000000",
                        "BoardHeight": 30,
                        "BoardHeightUnit": 1,
                        "BoardWidth": 90,
                        "BoardWidthUnit": 1,
                        "BoardX": 0,
                        "BoardXUnit": 1,
                        "BoardY": 10,
                        "BoardYUnit": 1,
                        "SubtitleBoardConfigSwitch": 1
                    },
                    "SubtitleLayoutConfig": {
                        "Alignment": "bottom",
                        "LineSpacing": 0,
                        "LineSpacingUnit": 0,
                        "SubtitleLayoutConfigSwitch": 0
                    },
                    "SubtitleOutlineConfig": {
                        "OutlineAlpha": 1,
                        "OutlineColor": "0x000000",
                        "OutlineWidth": 1,
                        "OutlineWidthUnit": 0,
                        "SubtitleOutlineConfigSwitch": 1
                    },
                    "SubtitleShadowConfig": {
                        "ShadowAlpha": 1,
                        "ShadowColor": "0x000000",
                        "ShadowWidth": 0,
                        "ShadowWidthUnit": 0,
                        "SubtitleShadowConfigSwitch": 0
                    }
                },
                "Type": "Preset",
                "UpdateTime": "2026-03-17T15:06:16+08:00"
            }
        ],
        "TotalCount": 12,
        "RequestId": "52176f0d-29bd-4b2c-bb84-1670cbbeac0f"
    }
}

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.
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.