DescribeSmartEraseTemplates

Last updated: 2025-10-13 10:34:18Download PDF

1. API Description

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

This API is used to obtain the list of smart erasing template details based on the unique identifier of the template. The returned result includes all matching user-defined smart erasing templates and system preset smart erasing 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: DescribeSmartEraseTemplates.
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	Filtering condition for the unique identifier of the smart erasing template. Length limit of the array: 100.
Offset	No	Integer	Pagination offset. Default value: 0.
Limit	No	Integer	Number of returned entries. Default value: 10. Maximum value: 100.
Type	No	String	Filtering conditions for template type. If this parameter is not specified, all templates are returned. Valid values: * Preset: system preset template. * Custom: user-defined template.
Name	No	String	Filtering condition for the smart erasing template name. Length limit: 64 characters.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of records that meet the filtering conditions.
SmartEraseTemplateSet	Array of SmartEraseTemplateItem	List of smart erasing 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 All Smart Erasing Templates

This example shows you how to query information about all smart erasing templates, including system preset templates and custom templates.

Input Example

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

{}

Output Example

{
    "Response": {
        "RequestId": "e2ad2688-ca7c-4f85-bbb0-1cfbdf258013",
        "SmartEraseTemplateSet": [
            {
                "AliasName": "FaceAndLicensePlateBlur",
                "Comment": "",
                "CreateTime": "2025-07-15T10:51:04+08:00",
                "Definition": 302,
                "ErasePrivacyConfig": {
                    "PrivacyModel": "blur",
                    "PrivacyTargets": [
                        "plate",
                        "face"
                    ]
                },
                "EraseSubtitleConfig": null,
                "EraseType": "privacy",
                "EraseWatermarkConfig": null,
                "Name": "The human face and license plate are blurred.",
                "Type": "Preset",
                "UpdateTime": "2025-07-15T10:51:04+08:00"
            },
            {
                "AliasName": "FaceBlur",
                "Comment": "",
                "CreateTime": "2025-07-15T10:51:04+08:00",
                "Definition": 301,
                "ErasePrivacyConfig": {
                    "PrivacyModel": "blur",
                    "PrivacyTargets": [
                        "face"
                    ]
                },
                "EraseSubtitleConfig": null,
                "EraseType": "privacy",
                "EraseWatermarkConfig": null,
                "Name": "The human face is blurred.",
                "Type": "Preset",
                "UpdateTime": "2025-07-15T10:51:04+08:00"
            },
            {
                "AliasName": "WatermarkRemoval-AdvancedVersion",
                "Comment": "",
                "CreateTime": "2025-07-15T10:51:04+08:00",
                "Definition": 201,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": null,
                "EraseType": "watermark",
                "EraseWatermarkConfig": {
                    "WatermarkEraseMethod": "auto",
                    "WatermarkModel": "advanced"
                },
                "Name": "Watermark removal-Advanced Edition.",
                "Type": "Preset",
                "UpdateTime": "2025-07-15T10:51:04+08:00"
            },
            {
                "AliasName": "SubtitleRemoval_OCRExtractSubtitlesAndTranslateToEnglish",
                "Comment": "",
                "CreateTime": "2025-07-15T10:51:04+08:00",
                "Definition": 103,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "ON",
                    "SubtitleEraseMethod": "auto",
                    "SubtitleFormat": "vtt",
                    "SubtitleLang": "zh_en",
                    "SubtitleModel": "standard",
                    "TransDstLang": "en",
                    "TransSwitch": "ON"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Subtitle removal_extract subtitles through OCR and translate them into English.",
                "Type": "Preset",
                "UpdateTime": "2025-07-15T18:36:53+08:00"
            },
            {
                "AliasName": "SubtitleRemovalAndOCRExtractSubtitles",
                "Comment": "",
                "CreateTime": "2025-07-15T10:51:04+08:00",
                "Definition": 102,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "ON",
                    "SubtitleEraseMethod": "auto",
                    "SubtitleFormat": "vtt",
                    "SubtitleLang": "zh_en",
                    "SubtitleModel": "standard",
                    "TransSwitch": "OFF"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Subtitle removal_extract subtitles through OCR.",
                "Type": "Preset",
                "UpdateTime": "2025-07-15T18:36:53+08:00"
            },
            {
                "AliasName": "SubtitleRemoval",
                "Comment": "",
                "CreateTime": "2025-07-15T10:51:04+08:00",
                "Definition": 101,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "OFF",
                    "SubtitleEraseMethod": "auto",
                    "SubtitleModel": "standard",
                    "TransSwitch": "OFF"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Subtitle removal.",
                "Type": "Preset",
                "UpdateTime": "2025-07-15T10:51:04+08:00"
            },
            {
                "AliasName": "",
                "Comment": "",
                "CreateTime": "2025-08-04T15:16:25+08:00",
                "Definition": 200385,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "OFF",
                    "SubtitleEraseMethod": "auto",
                    "SubtitleModel": "standard",
                    "TransSwitch": "OFF"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Testing 8.",
                "Type": "Custom",
                "UpdateTime": "2025-08-04T20:08:14+08:00"
            },
            {
                "AliasName": "",
                "Comment": "",
                "CreateTime": "2025-07-02T20:49:04+08:00",
                "Definition": 200022,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "OFF",
                    "SubtitleEraseMethod": "auto",
                    "SubtitleLang": "zh_en",
                    "SubtitleModel": "standard",
                    "TransSwitch": "OFF"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Testing 7.",
                "Type": "Custom",
                "UpdateTime": "2025-08-04T20:08:14+08:00"
            },
            {
                "AliasName": "",
                "Comment": "",
                "CreateTime": "2025-07-02T20:48:48+08:00",
                "Definition": 200021,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "OFF",
                    "SubtitleEraseMethod": "auto",
                    "SubtitleModel": "standard",
                    "TransSwitch": "OFF"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Testing 6.",
                "Type": "Custom",
                "UpdateTime": "2025-08-04T20:08:14+08:00"
            },
            {
                "AliasName": "",
                "Comment": "",
                "CreateTime": "2025-07-02T19:21:24+08:00",
                "Definition": 200019,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "OFF",
                    "SubtitleEraseMethod": "custom",
                    "SubtitleModel": "standard",
                    "TransSwitch": "OFF"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Testing 5.",
                "Type": "Custom",
                "UpdateTime": "2025-08-04T20:08:14+08:00"
            }
        ],
        "TotalCount": 14
    }
}

Example2 Querying the Specified Smart Erasing Template

This example shows you how to query information about the specified smart erasing template.

Input Example

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

{
    "Definitions": [
        200019
    ]
}

Output Example

{
    "Response": {
        "RequestId": "83c6c7c2-3dab-4c6a-bedb-227371c038c0",
        "SmartEraseTemplateSet": [
            {
                "AliasName": "",
                "Comment": "",
                "CreateTime": "2025-07-02T19:21:24+08:00",
                "Definition": 200019,
                "ErasePrivacyConfig": null,
                "EraseSubtitleConfig": {
                    "OcrSwitch": "OFF",
                    "SubtitleEraseMethod": "custom",
                    "SubtitleModel": "standard",
                    "TransSwitch": "OFF"
                },
                "EraseType": "subtitle",
                "EraseWatermarkConfig": null,
                "Name": "Testing 5.",
                "Type": "Custom",
                "UpdateTime": "2025-08-04T20:08:14+08:00"
            }
        ],
        "TotalCount": 1
    }
}

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.