tencent cloud

APIs

DocumentationAPIsVideo on DemandParameter Template APIsCreateWatermarkTemplate

CreateWatermarkTemplate

Download
Focus Mode
Font Size
Last updated: 2026-05-19 15:01:12

1. API Description

Domain name for API request: vod.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: 2018-07-17.
Region No String Common Params. This parameter is not required.
Type Yes String Watermark type. Valid values:
  • image: image watermark.
  • Text: text watermark.
  • svg: SVG watermark.
    		•
    SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
    Name No String Watermark template name. The length cannot exceed 64 characters.
    Comment No String Template description, with a length limit of 256 characters.
    CoordinateOrigin No String Origin position. Valid values:
  • TopLeft: indicates that the coordinate origin is at the top left corner of the video image and the watermark origin is at the top left corner of the image or text.
  • TopRight: indicates that the coordinate origin is at the top right corner of the video image and the watermark origin is at the top right corner of the image or text.
  • BottomLeft: indicates that the coordinate origin is at the bottom left corner of the video image and the watermark origin is at the bottom left corner of the image or text.
  • BottomRight: indicates that the coordinate origin is at the bottom right corner of the video image and the watermark origin is at the bottom right corner of the image or text.

    • Default value: TopLeft.
    XPos No String The horizontal position of the watermark origin from the origin of coordinates of the video image. Support two formats: % and px.
  • If a string ends with %, it indicates that the XPos of a watermark is a specified percentage of a video's width. For example, 10% means that XPos is 10% of a video's width.
  • If a string ends with px, it means the watermark XPos is specified in pixels, for example, 100px means XPos is 100 pixels.

    • Default value: 0px.
    YPos No String The vertical position of the watermark origin from the origin of coordinates of the video image. Supports two formats: % and px.
  • If a string ends with %, it indicates that the YPos of a watermark is a specified percentage of a video's height. For example, 10% means that YPos is 10% of a video's height.
  • If a string ends with px, it means the watermark YPos is specified in pixels, for example, 100px means YPos is 100 pixels.

    • Default value: 0px.
    ImageTemplate No ImageWatermarkInput Image watermark template. This field is required when Type is image. Invalid field when Type is text.
    TextTemplate No TextWatermarkTemplateInput Text watermarking template. This field is required when Type is text. Invalid field when Type is image.
    SvgTemplate No SvgWatermarkInput SVG Watermark Template. This field is required when Type is svg. Invalid field when Type is image or text.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique identifier of the watermark template.
    ImageUrl String URL of the image watermark. 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

    https://vod.intl.tencentcloudapi.com/?Action=CreateWatermarkTemplate
&Type=image
&Name=Template 1
&ImageTemplate.ImageContent=/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxITEhUSEhIVFRUXFRUXFxcYFRUVFRUXFxUXFhUVFxUYHSggGBolHRUXITEhJSkrLi4uFx8zODMtNygtLisBCgoKDg0OGhAQFy0dHx4tLS0tLS0tLS0tLSstLS0tLS0tLS0tLS0tLS0tLS0tLS0tLTEtLS0tLS0rLS0tKystLf/AABEIAOEA4AMBIgACEQEDEQH/xAAcAAAABwEBAAAAAAAAAAAAAAAAAQIDBAUGBwj/xABBEAABAwIDBAYHBQYGAwAAAAABAAIRAwQFITESQVFhBiJxkbHREzJTgaHB8BRCUpKTByNigrLxFTRDcsLhM1Rz/8QAGQEAAgMBAAAAAAAAAAAAAAAAAQIAAwQF/8QAJBEAAgIBBAICAwEAAAAAAAAAAAECEQMSITFBBFEiMhMjYXH/2gAMAwEAAhEDEQA/AIX2+t7ar+o/zRfb63tqv6j/ADTUIQtBjsd+31vbVf1H+aL7fX9tV/Uf5pqEIQJY7/iFb21X9R/mh9vr+2q/qP8ANMwgQpRLHf8AEK3tqv6j/NGMQr+2q/qP80zCEKEski/re2q/qP8ANKbfVvbVf1H+ajwoWIYoyllq7gPmpsgq2XAv63tqv6j/ADVdd9KjTy9PVJ4B7z81l8QxirV0Ba3g3zVYST9cUjn6LY4/ZpbjpvcfdfUHbVcT3SkjprdD77v1H696zgCVO7/v3JLZZoRpmdObjeX/AKr1Mt+nB+8+qP53H5rEo4R1MDgjptnj5qepXeTw9I6fFTxd1fa1Pzu81yOm8ggtMEbwYVvY9JKzIBggbuKZT9lbxPpnRxdVfa1Pzu80r7VV9rU/O7zWXw3pbSedmoCw8dR7+C01JwcJaZB3qxNMqakuR0XVX2tT87vNLFzV9pU/O7zSA1LDURbFi5q+0qfnd5pYuKntH/nd5puEpQFjouantH/nd5pX2qp7R/53eaYlBQlsf+11PaP/ADu80l13U9o/87vNNIlCWzMoQjQhAcKEEaIBQgUII0FCBQiJAElB7gBJMQsxf4wXy0AhvdISylQ0Y2SMWxv7lPjmcvgs/UcSZmZP9kezyjj2pOzvGSpbs0RikEEptLf2TwCWxmcd/ZPxS2tPuge7kgMILdSkBvBSXndpz+RTtKlkZy0+PZwhCw0QCSi2fFPejIMRPxS30ico/t2qWiURnZpI7FKFqcssuKYeIP1vRTTJTQkBaPoz0i9D+7qepOR12f8ApZwHkkwmToWUU1TOx29drwHNIIInIp9c36KYyaVXYc47DgGxwzyK6NTcCARvAV8ZWjJOOli0aEIwEwgSMBKARgIEEwhspyEShDLII4RIDhII0FCBIFGo2IVwym4kxke/cgRFHjuJSTTYerHWMb+3kqZoLj7+9Jc7aPPxV3hNiXEZADjH1KzTlW7NkIXsiHZYW5+eyYHxVlR6NvdnkB2z8Mlp7e1AAaFY06cLFPO+jdDx49mab0a2iC52mXAnxACm0+irIzzjTcPfvKvmU0+1qqeaXst/DD0Zl3Rdu4xlHFHTwEs062WcyI7AtT6NIexD8kvYfxx9GVo4K1pMNGZ3+CeZhbQZLRKvKlNNejQc5ewqEfRQV7UcOaq7zD2O1Ga1NzRVPc0iE8Jv2LLGn0Zm9wwaj4CFVVaZBha6o3dxVHf0QOS148jfJkyY64Kk8ZW56KdI9oMo1D1vVBO/PL4LEP8A7o7WrsuDomDotMZUZJx1I7SAlQoWCXAqUWOBnqiTzjNWELQY6CASoRgI1AhIiEopKhDLIIIIBCKCNEoEJUHSetk1g+ty0CyWPVD6aNMoHv18Ek3sPjVsrrVvW0lbTCaUAKjwq1GpOnJanC2b/FYMsrOlhVFrb0lMp0km3arCiwLG0bExFK2lPfZ41Cm2jQpbqLYTRhaFc6ZViiCkvt+AVm2m0Jymz3fW9NoBrM8LfNIdbRuVldNgmNDoolV6TT0OnZXVaCqL6jCviclV328dyUYzl01U2JDIrQ3TVR3rMytOJmbKigq09/MppwU59IZ8PBQnDPVbYsxNHRv2fX23RLD/AKZgc5khawLn37N7mH1KXEbU9mXzXQVohwY8i+QaCCNOIEiISkShDKokaCUYEIkaChBLisZibiazs8pAy13fUrZvGRWO2AaxmSC48pjtVWTgtxclzbNIY3akToOXHT4q/wAMp/ez96rqFMOeGiTAy38h2ZrQ0KGyBvXOyM6eNE6gpVN+5RKDlNpMJVDNCJNJTPS5KOylopLaE5po2B0KbU+venm1ITTqB5ptzCrN0KN3jSRKq3unJW5okhQa1OEkk+RkytqSoN4JCtq4Crq7JVdMbUZ69VY6mCSD9cleX1GNypqhhytgVzKW+so0yVTUbBWquKe0DKzl7Sg71rxy6MeSNbl10ArbNyRl1mkaZ6jRdPXK+gz2tugXDMNMdpLfkuqBbIcGHL9g0oJKNWFQaJGhChDKII0EoQoQQhBQICFj6/8AmncA45fWi2KymM0w25aR97Z8YPgqsvBbh+xsMLoiGkD6zP8A0rkiAmLCmA0RwT1ycoXMe7OtHZCqB3wra3qCP7LD4njrGnYY/IZFwgkn8LZy96qX9IqzjDQ7I9oAO8neU0MLe7ElmSOoPvWgxI707Tv2zr9ZrlDcRuHDIOnsjszOoTmGOutsF0x2p3BLsWORvo67SvAU/dV27gslhty45OV5mRkq1MuUfYr7V1Y5lZvG8ebSMGc1JxGts9qzt5ZOqzOiCmr3DKL6GK3Slsd3PVQn9J4P0QZ38Uh/R+mZBqgfGPemn9Grb/28+UfNXLQzM/yIdfj+0c9PrRM3lVr27TSDGfNRLjo8I/d1g7hlBVS61q0jviYR0xfBNc1yXzXyFT4vEab8lOtasgDtUDGclIL5Bm7iSeg3+cYMs2vGfuM/BdWBXKOh73Nque1oJDCJOjZIMxvOS2GAYxUfXNJzi9samMnDPKN2q1xyxT0mPJgk059GoSkQSgtBkCQSkSIDKIIBGkHEo0EahAst5AkwJ4rP9KLZ4LHlvq5GNI3H4LTW9EOOe6D8lcVMOa5oDhLXNAPvyWHNmlGbXR08GCEsSl2QMDrbVJh/hCRjT6jhsU9TlKawC3dSY6k7/Te5o5t1ae4hWgcGgk6rK3Tsvq0Zyw6OsZ16xnt0U6titvbjKkC6JgNzjjET3qPija1Uj0e7Q5w3+KN5U7DcPdRpvYWNq+kBDnGdsyI14J1LV9mBwrhFLd9Lqjmsey3AY9z2tMt2iaeyXZZ7nt71YWlapDC8bO20OZtAQ6RMBwyUSh0LYBL9viPVAjh4Zq8DS9oa5ztlsACGbIAA0yzOSM1B8IMFO9x+zrEEToZj3arRUX5LMW1qZGZIzgnhxhXT6sCAs/BdVlL0hqxmFXmr+7l8nOAwA9Y9vBPYt1pb70ixDxBGcZx8DHNRMjQHYbRq29UPLvSuYQxoY8U2EDICBmZykrB18Oq9RpobOy0t2oILpe92048RtbPY0Lp7aj3ZiCAdDuO7sUO6YSetTk9shaVlpbFDw6ndmPxC2DGt9ASSBDwZLSQNQToUeE19oRUHfl8VpK9m85BoH1wUZ1hsbpSPJYyx0VmIUBq3cRkNM9TKpcbpTsxxhau7I2fFZvEjpyMpsbK8keg8LBaC1mU5E/JaHo5Qgl34XDzWYwh5LxA35rV4OYqvpRqA75fNR3qLI1odmuSgiASguucICIpSSVAGVQRoJBgkEaJQJIsndaOPnK04jYA/hCyLTBB4LWW2bAePkFg8qFO/Z0/CyXFx9FSXj0jgNwgmInWCVL9GCM1GvGQ5x7Pip1IaLIzVwxhtLknWUHbpUkfNOsJKCHVkdtiD6xntTjLJs6ZeKlbHNIqyeQRbJRGqxOSaeEqqc4RtYUjHiUONU4IISbKvEdqlYvRJGSpretl1gcjBTJbAkagUmuEjJ3Him3AtOYkcVHwsl4dsuyB6vMfUqwcw6OQ3BQgUwRKgX9LxU0tjRR7t8jNQlGZvNVm8Q1IWgxMweSz18ZcVfAzTDwLKq1vNbLDqU3sjQUiT+YAeKw+GVIrTwct90ZBc+pV3ENaPiSfirscbyoTNKsLNAEoIkoLpHHAiKMoioQyqCCASDgRI0FCAV/hF6BTg7j3cFQQpeHv62zucqPIjqh/hp8XJoyb9ljXeHh7hqMvhPyUuxdMIqduNh7tBE9pCjYXWiD9clzFudVrcunU5TzKXBJa8EZJbaobmikhuhVRjWCXKqunvfpIHJIvLsvqbMyBmeSFxdvYOq3ak9yVyTY2mhVnZETKs7bDy4bUgCeKoPtVV8ZAe8g/EJ99+WdVxgoxoDsdxWm0TnkqO2sgS47iouMX73mGCT8BzKTTFYAAujjuQaChNep6CoHNMAkAjtK1dC4DxDlljh+04Fx2oiFYNqmeqcx9Qg2FRLio2FWXZyOfZyTrLwObPuPaod28ZoWRozeLOzKzlc5+8BX186do9qj4Hg32n0gmC1oLTuDpkTygELViTeyMWWSjuyHaWshzQOsSAO1zgAumYfaClTawbtTxO8qgwno/Ua5vpNkBpByMl0GQNMs1qFt8fG1bkjD5WROlF7CglAJISgtJkAUkpRSHIkMsEEaIpBwIII0CBJVJ+yQeCSgg1ewU6dotb3FdqnsNBE5HsTdmeqO7uVcFPsn5HtlY82GMIfE3YM8p5KkXdtcSAmcQu9kbydAOJ0ATAOy7LQ5pqqCarJ4OI7d3iVzr3o6aJVtS2BBPWdm48+HYEp9QBR6VWRmeKYfeU9xk8vin0g1NkpzphSK9EPIDgDl3qlN7OgA96l22JNAh45ZHNPFEaJdagxoMAdqqqqO8v9qWsaR8SQozba4c1z2McQ2ZMRp2oyiwKkt2KfXIChPvIO/MhJuRcgNPoydoEjIaDwVNQxDaeA4RnCCgBzS4Zp6dTNrhlJ2T/AMT8vekX7oBRUTtFobMbbfhmfBFjOh5mFXJfIfVaKG/MM7Vf9CKEUXP/ABPPc0AeJKz2MmIHL68Fs8BobFvSb/CHHtd1j4roeIt7OX5j2osUpIBSpXQOcLCNJlHKhAyUgoyU24qEM2iCNBIMEjRIIBAgggoQMJ+3dBTATjUs46otDQlpkmXPrMBGrU7VbLG1B9x0nsOR8VAsq8GDoVPtHAFzDo4GPmFxZR0ypndhK1aMz0ntq07VJ5AJMgcI3IdCatL0hpXDBDvUeTMkjNp/CZzWop0AWZ6iR3KixHCQHF7RkdRwKvhJcCTx6uGdHsrW22mP2WSWwNM4U+jh1tskGlTIk5Fo35/Ncmcyp1DtuGyDsEE9WdYCsLW5rtZAJkmS7aqAnLfDoO5WxoreGXs6Bh1rRoh7WNaBtl2QG/MeKrrrHLVjHsdVpjrO6u02ZIk5ayslWq1jT2c2tlxkbQc6c83kklZ64tw0yBHie1BugxwN8sn430oDzSNNmWw/bDsnNJgNAGk5EqowLCh653ccyY3k8UdKxJIMZeKums2QBuVUp7UiyONJj1qAHTwBPvOSq7yrtP5DNO17iAQN+Sp7+42WnmqkrY8nSIzqZr3DaY3uA7B9490rojRGQ3LMdDsN2Wmu4ZuyZybvd7/Ac1p11/HhpicTycmqW3QYSpSQjC0GcUEpJRqEAU25KJSHFQhnUEESQcNEgggQCCCChAwnGpsJ1qgB+i2dNfrJSaNTLm0pWG2pc19TdT2Af5zA8Em5plp2h71zPKj+w6/iS/Wi0FQZOHquS30pCh2Lw4Fh0OY5FTKVQxBWc1FdcWhGbe5OW9zs6thT3AHI78kxWtWlWRmyPgYu7wuECFV/ZOOZVv6BrfqU3UA3ITk2SOxXGiGqJdVsslZVmKqqDPsVaCyBdOg5lUGIV9olS8YusyAqsK+EezNkl0dQsKezTY3gxo7mhSFGsq4cwHkJ7lIBXYjwcWXLFApUpCOURRcoSkyjKgQim3FKcU28qAKJEggkLAIkaJAgaJBBQgoJF3dCkwvO7QcTuCMuAEkwOKyuNYj6R2XqtmBx5oSdBjG2dQ6D2z3YVXrPkuq1S/8AlZDRHKWlEWghbXofhwp2NGiRl6FocOJLZd8SVlbq19HVfSdq05TvafVcPrisHkrs6XivopgCx3KVaEzBG9Ir20qMKux1XabvJZas13ROmDmlGCNVFbV2s1Ip00VFh1obc0HTxTTwpDxHkodUgcvei4k1ke4qZGVn7y4hriVJxO9gQDos5d1zUMDTfzQUBZTvYr3AvcSnBRJIaBmSAO0mApbKELQ9CMGNWv6QjqUsyeLvuj59yvi9TKZLTGyu6QXrrK7pkSWGmGPb+INOvaNpbCjVDmh7TIcAQeIKx/7UqPXpu5uHfBHgmugmOAD7NUO+aZPxZ8wt+OVbM5uaF7o3ISkiUcq8zCkZKTKIlEgHFNPKW4pmoVCFMECggqiwCCbrVmtEucAOZVVddIGDJg2jx0b5oNpBSbLlQL3FadPftO4DM+/gs3d4xUqZF0DgMgoYCRz9Fix+ywvMRfV1yG5o09/FR6TJIB+85o7yAk7k/ZD95T/+lP8ArCQs4PUtmyGAcgq/pBg4rtBbAqt9U8eLTyPwVnS0TiElezHi63RznZIJa4FrgYIOoKaubYHI6FbXG8IFYbTYbUGh3OH4Xcue5ZSs0tJa5pDhqDu8xzWGeNwf8N0Mimv6Z+pbPYcsxzTTsQIyIzV86kN6iXFkDuS6qG0lK/ETrKi3N4SFNu8NnTvUf/DQOfajriDQ/ZnbtxPZohZ2ytbi1CXa2ZyAEkmABqTuA5qOTaCopMjULF1R7abBLnGAO3eeQ811CxwtttQFJva4/icdSU70V6NC2Z6WoAarh27A/CD4lWFZm3PBbMGLSrZkz5NTpHJv2n2802Hg8eXzXMnGDIy4bl1z9pNL92Qd0HuK5HWGasfJQjZ4D01iGXPICoP+Q+YWytbtlQbTHBw4ggriyftbp9M7VN7mHi0kf3TxyNclcsKfB2iUCVzuw6a12ZVWioOPqu7xkVo7HpfbVMi403cHiB+bRXKcWUvFJdF84pmqckbaocJaQQd4IITdY5FOV0ViS/RBBVMtRjcT/wDIVXVNUaCpkaIcBUNU/wAEEEiGY4dFJtvWZ/vb/UESCZCs9T2+gTqCCD5GXASyfS7/AMzP9jv6gggqs30Zdh+xSnROhBBY2beyLdfNVlT5o0FX2ErKytuiP+cp/wA39KCCvx/ZFc/qzp196qi0tEaC6SOccu/aX6r/AK3rkFb1j2oIJZEQ2jQQSjD7Uh6CCgF2aHoN65W7r+qUEFqhwZZ8n//Z
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Definition": 1001,
        "ImageUrl": "http://example.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/aa.jpeg",
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

    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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InternalError.GenDefinition Internal error: failed to generate template ID.
    InternalError.UploadWatermarkError Internal error: failed to upload watermark image.
    InvalidParameterValue.Comment Invalid parameter: template description.
    InvalidParameterValue.CoordinateOrigin Incorrect parameter value: CoordinateOrigin.
    InvalidParameterValue.Height Invalid parameter: height.
    InvalidParameterValue.ImageContent Invalid ImageContent.
    InvalidParameterValue.ImageTemplate Invalid parameter: image watermarking template.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RepeatType Invalid parameter: 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 Invalid parameter: text transparency.
    InvalidParameterValue.TextTemplate Invalid parameter: text template.
    InvalidParameterValue.Type Incorrect Type parameter value.
    InvalidParameterValue.Width Invalid parameter: width.
    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 exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket.
    UnauthorizedOperation Unauthorized operation.
    Previous Topic: CreateAigcVideoRedrawTaskNext Topic: CreateSnapshotByTimeOffsetTemplate

    Help and Support

    Was this page helpful?

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

    Feedback