tencent cloud

Creating Templates
Download PDF
Last updated: 2025-09-09 20:02:27
Creating Templates
Last updated: 2025-09-09 20:02:27
Download PDF

Feature Description

Create a video object detection template.

Authorization Description

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

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 AI Content Recognition Service in advance via console or API. For details, see Enable AI Content Recognition 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>VideoTargetRec</Tag>
    <Name>TemplateName</Name>
    <VideoTargetRec>
        <Body>true</Body>
        <Pet>false</Pet>
        <Car>true</Car>
    </VideoTargetRec>
</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
Data description for
Request
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Template type: VideoTargetRec
String
Yes
Name
Request
Template name, only supports Chinese, English, digits, _, -, and *, length not exceeding 64
String
Yes
VideoTargetRec
Request
Video object detection parameter
Container
Yes
Data description for
VideoTargetRec
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Default Value
Available Values
Body
Request.VideoTargetRec
Whether human detection is enabled
string
No
false
true/false
Pet
Request.VideoTargetRec
Whether pet detection is enabled
string
No
false
true/false
Car
Request.VideoTargetRec
Whether vehicle detection is enabled
string
No
false
true/false
Plate
Request.VideoTargetRec
Whether license plate detection is enabled
string
No
false
true/false
Face
Request.VideoTargetRec
Whether face detection is enabled
string
No
false
true/false
SnapshotFreq
Request.VideoTargetRec
Detection frequency, a floating-point number in the [0,30] interval
string
No
1
[0,30]
ProcessType
Request.VideoTargetRec
Processing method; if empty, only detection and return information are performed; if not empty, it indicates enabling post-processing after detection, supporting mosaic type; only Face and Plate detections support post-processing.
string
No
Mosaic
Mosaic
TransTpl
Request.VideoTargetRec
Post-processing parameter Take effect and is required when ProcessType is not empty
Container
No
None.
None.
Note:
Body, Pet, and Car cannot all be false.
When detection is enabled (ProcessType is not empty), Body, Pet, and Car cannot be true.
The specific data description of Container type TransTpl is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Default Value
Limit
Container
Request.VideoTargetRec.TransTpl
Container format
string
Yes
None.
None.
Codec
Request.VideoTargetRec.TransTpl
encoding/decoding format
string
No
None.
H.264,H.265
Bitrate
Request.VideoTargetRec.TransTpl
video bitrate
string
No
original video bitrate
Value range: [10, 50000]
Unit: Kbps
Crf
Request.VideoTargetRec.TransTpl
bitrate - quality control factor
string
No
None.
Value range: (0, 51]
If Crf is set, the setting of Bitrate becomes invalid.
When Bitrate is empty, it defaults to 25.
Width
Request.VideoTargetRec.TransTpl
Wide
string
No
None.
Value range: [128, 4096]
unit: px
If only Width is set, calculate Height according to the original aspect ratio of the video.
Height
Request.VideoTargetRec.TransTpl
High
string
No
None.
Value range: [128, 4096]
unit: px
If only Height is set, calculate Width according to the original aspect ratio of the video.
Fps
Request.VideoTargetRec.TransTpl
Frame Rate
string
No
Original Frame Rate of Video
Value range: (0, 60]
unit: fps
The specific data description of Container type Container is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Format
Request.Container
Encapsulation format: Supports mp4, flv, mkv, hls, ts, avi, mov
String
Yes
ClipConfig
Request.Container
Sharding configuration, valid when format is hls
Container
No
The specific data description of Container type ClipConfig is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Duration
Request.Container.ClipConfig
Segment duration. The default value is 5 seconds.
String
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>VideoTargetRec</Tag>
        <Name>TemplateName</Name>
        <State>Normal</State>
        <Tag>VideoTargetRec</Tag>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VideoTargetRec>
            <Body>true</Body>
            <Pet>false</Pet>
            <Car>true</Car>
        </VideoTargetRec>
    </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
RequestId
Response
unique request ID
String
Template
Response
Container for saving template details
Container
Container node
Template
content:
Node Name (Keyword)
Parent Node
Description
Type
TemplateId
Response.Template
template ID
String
Name
Response.Template
Template Name
String
BucketId
Response.Template
Template's associated bucket
String
Category
Response.Template
Template Property, Custom or Official
String
Tag
Response.Template
Template type: VideoTargetRec
String
UpdateTime
Response.Template
Update time
String
CreateTime
Response.Template
Creation time
String
VideoTargetRec
Response.Template
In the request body: Request.VideoTargetRec
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-chongqing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml

<Request>
    <Tag>VideoTargetRec</Tag>
    <Name>TemplateName</Name>
    <VideoTargetRec>
        <Body>true</Body>
        <Pet>false</Pet>
        <Car>true</Car>
    </VideoTargetRec>
</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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
    <Template>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <State>Normal</State>
        <Tag>VideoTargetRec</Tag>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VideoTargetRec>
            <Body>true</Body>
            <Pet>false</Pet>
            <Car>true</Car>
        </VideoTargetRec>
    </Template>
</Response>

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

Feedback