CreateWatermarkTemplate

Last updated: 2025-12-02 14:26:24Download PDF

1. API Description

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

This API is used to create a custom watermarking template. Up to 1,000 templates can be created.

A maximum of 100 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: CreateWatermarkTemplate.
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.
Type	Yes	String	Watermarking type. Valid values: image: Image watermark; text: Text watermark; svg: SVG watermark.
Name	No	String	Watermarking template name. Length limit: 64 characters.
Comment	No	String	Template description. Length limit: 256 characters.
CoordinateOrigin	No	String	Origin position. Valid values: TopLeft: The origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text; TopRight: The origin of coordinates is in the top-right corner of the video, and the origin of the watermark is in the top-right corner of the image or text; BottomLeft: The origin of coordinates is in the bottom-left corner of the video, and the origin of the watermark is in the bottom-left corner of the image or text; BottomRight: The origin of coordinates is in the bottom-right corner of the video, and the origin of the watermark is in the bottom-right corner of the image or text. Default value: TopLeft.
XPos	No	String	The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported: If the string ends in %, the `XPos` of the watermark will be the specified percentage of the video width; for example, `10%` means that `XPos` is 10% of the video width; If the string ends in px, the `XPos` of the watermark will be the specified px; for example, `100px` means that `XPos` is 100 px. Default value: 0 px.
YPos	No	String	The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported: If the string ends in %, the `YPos` of the watermark will be the specified percentage of the video height; for example, `10%` means that `YPos` is 10% of the video height; If the string ends in px, the `YPos` of the watermark will be the specified px; for example, `100px` means that `YPos` is 100 px. Default value: 0 px.
ImageTemplate	No	ImageWatermarkInput	Image watermarking template. This field is required and valid only when `Type` is `image`.
TextTemplate	No	TextWatermarkTemplateInput	Text watermarking template. This field is required and valid only when `Type` is `text`.
SvgTemplate	No	SvgWatermarkInput	SVG watermarking template. This field is required and valid only when `Type` is `svg`.

3. Output Parameters

Parameter Name	Type	Description
Definition	Integer	Unique ID of a watermarking template.
ImageUrl	String	Watermark image address. This field is valid only when `Type` is `image`.
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 Creating a Watermark Template

Input Example

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

{
"Name": "Watermark Template 1",
"Comment": "svg watermark"
    "Type": "svg",
    "CoordinateOrigin": "TopRight",
    "XPos": "5%",
    "YPos": "5%",
    "ImageTemplate": {
        "ImageContent": "",
        "Width": "10%",
        "Height": "0px",
        "RepeatType": "once"
    },
    "TextTemplate": {
        "FontType": "arial.ttf",
        "FontSize": "10px",
        "FontColor": "#ffffff",
        "FontAlpha": 0.5
    },
    "SvgTemplate": {
        "Width": "10%",
        "Height": "0px"
    }
}

Output Example

{
    "Response": {
        "Definition": 123,
        "ImageUrl": "",
        "RequestId": "93dda61a-c2c5-465d-a78c-0860997fb01b"
    }
}

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.
InternalError.GenDefinition	Internal error: failed to generate template ID.
InternalError.UploadWatermarkError	Internal error: failed to upload watermark image.
InvalidParameterValue.Comment	Parameter error: template description.
InvalidParameterValue.CoordinateOrigin	Incorrect parameter value: CoordinateOrigin.
InvalidParameterValue.Height	Parameter error: height.
InvalidParameterValue.ImageContent	Invalid ImageContent
InvalidParameterValue.ImageTemplate	Parameter error: image watermarking template.
InvalidParameterValue.Name	Incorrect parameter value: `Name` exceeds the length limit.
InvalidParameterValue.RepeatType	Parameter error: invalid `RepeatType`.
InvalidParameterValue.SvgTemplate	Incorrect parameter value: SVG is empty.
InvalidParameterValue.SvgTemplateHeight	Incorrect parameter value: SVG height.
InvalidParameterValue.SvgTemplateWidth	Incorrect parameter value: SVG width.
InvalidParameterValue.TextAlpha	Parameter error: text transparency.
InvalidParameterValue.TextTemplate	Parameter error: text template.
InvalidParameterValue.Type	Parameter error: incorrect `Type` value.
InvalidParameterValue.Width	Parameter error: Wwdth.
InvalidParameterValue.XPos	The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported.
InvalidParameterValue.YPos	The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported.
LimitExceeded.TooMuchTemplate	Limit reached: the number of templates exceeds the limit.