tencent cloud

Creating Templates
Download PDF
Last updated: 2025-09-09 18:33:04
Creating Templates
Last updated: 2025-09-09 18:33:04
Download PDF

Feature Description

Create an intelligent cover template.

Authorization Description

When used with a sub-account, the ci:CreateMediaTemplate permission is required. For details, see Cloud Infinite actions.

Activating a Service

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling Media Processing Service in advance via console or API. For details, see Enable Media Processing Service.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.


Request

Request sample

POST /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
Note:
Authorization: Auth String. For details, see Request Signature document.

Request header

This API only uses common request headers. For details, see Common Request Headers documentation.

Request body

The implementation of this request operation requires the following request body.
<Request>
    <Tag>SmartCover</Tag>
    <Name>TemplateName</Name>
    <SmartCover>
        <Format>jpg</Format>
        <Width>1280</Width>
        <Height>960</Height>
        <Count>10</Count>
        <DeleteDuplicates>true</DeleteDuplicates>
    </SmartCover>
</Request>
The data are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes
The specific data description for the
Request
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Template type: SmartCover
String
Yes
Name
Request
Template name: Supports Chinese, English, digits, _, -, and *; length not exceeding 64
String
Yes
SmartCover
Request
Intelligent cover parameter
Container
Yes

The specific data description for the
SmartCover
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Format
Request.SmartCover
Image format, supports jpg, png, webp.
String
jpg
No
Width
Request.SmartCover
Width
Value range: [128, 4096]
unit: px
If only Width is set, calculate Height based on the original proportion of the video.
String
Original width of video
No
Height
Request.SmartCover
High
Value range: [128, 4096]
unit: px
If only Height is set, calculate Width based on the original proportion of the video.
String
Original height of video
No
Count
Request.SmartCover
Number of screenshots, value range: 1 to 10
String
3
No
DeleteDuplicates
Request.SmartCover
Remove duplicates on cover Set value to true/false
String
false
No

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
    <RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId>
    <Template>
        <Tag>SmartCover</Tag>
        <Name>TemplateName</Name>
        <TemplateId>t1f43110a08702470b8fa75894629501fa</TemplateId>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <SmartCover>
            <Width>1280</Width>
            <Height>960</Height>
            <Format>jpg</Format>
            <Count>5</Count>
            <DeleteDuplicates>false</DeleteDuplicates>
        </SmartCover>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </Template>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node
Response
content:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
RequestId
None.
unique request ID
Container
Container node
Template
content:
Node Name (Keyword)
Parent Node
Description
Type
Tag
Response.Template
Template type: SmartCover
String
Name
Response.Template
Template name
String
BucketId
Response.Template
Template's bucket
String
Category
Response.Template
Template property: Custom or Official
String
TemplateId
Response.Template
template ID
String
UpdateTime
Response.Template
Update time
String
CreateTime
Response.Template
Creation time
String
SmartCover
Response.Template
Detailed template parameters, same as the description of request body Request.SmartCover
Container



Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

POST /template HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml

<Request>
    <Tag>SmartCover</Tag>
    <Name>TemplateName</Name>
    <SmartCover>
        <Format>jpg</Format>
        <Width>1280</Width>
        <Height>960</Height>
        <Count>10</Count>
        <DeleteDuplicates>true</DeleteDuplicates>
    </SmartCover>
</Request>

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=

<Response>
    <RequestId>NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=</RequestId>
    <Template>
        <Tag>SmartCover</Tag>
        <Name>TemplateName</Name>
        <TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <SmartCover>
            <Format>jpg</Format>
            <Width>1280</Width>
            <Height>960</Height>
            <Count>10</Count>
            <DeleteDuplicates>true</DeleteDuplicates>
        </SmartCover>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </Template>
</Response>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback