tencent cloud

Creating Templates
Download PDF
Last updated: 2025-09-15 17:39:16
Creating Templates
Last updated: 2025-09-15 17:39:16
Download PDF

Feature Description

Create a voice separation template.

Authorization Description

When using a sub-account, you need to add the ci:CreateMediaTemplate permission to the action in the authorization policy. For ALL supported operation APIs of Cloud Infinite, see CI action.

Service Activation

To use this feature, you need to bind a bucket in advance and enable Cloud Infinite service.
To use this feature, you need to enable Smart Audio Service in advance via the console or API.
Note:
After binding Cloud Infinite, if you manually perform the unbinding operation for a bucket, you will not be able to continue using this function.

Use Limits

When using this API, please confirm the related use limits. For details, see Use 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: A request header that carries authentication information to verify the legitimacy of the request. For details, see the Request Signature document.

Request header

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

Request body

The following figure shows the request bodies required for implementing this request operation.
<Request>
    <Tag>VoiceSeparate</Tag>
    <Name>TemplateName</Name>
    <AudioMode>IsAudio</AudioMode>
    <AudioConfig>
        <Codec>aac</Codec>
        <Samplerate>44100</Samplerate>
        <Bitrate>128</Bitrate>
        <Channels>4</Channels>
    </AudioConfig>
</Request>
The detailed data is described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes

Request
Container Type data description is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Template type: VoiceSeparate
String
Yes
Name
Request
Template name, supporting only Chinese, English, digits, _, -, and *, length not exceeding 64.
String
Yes
AudioMode
Request
Output audio
IsAudio: Output voice
IsBackground: Output background sound
AudioAndBackground: Output voice and background sound
MusicMode: Output voice, background sound, Bass, drums
String
Yes
AudioConfig
Request
Audio configuration
Container
Yes
Container type
AudioConfig
data description:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Codec
Request.AudioConfig
Encoding/decoding format: value aac, mp3, flac, amr, wav. When Request.AudioMode is MusicMode, only mp3, wav, aac are supported.
String
aac
No
Samplerate
Request.AudioConfig
sampling rate
Hz
8000, 11025, 22050, 32000, 44100, 48000, 96000
When the Codec is set to aac/flac, 8000 is not supported
When the Codec is set to mp3, 8000 and 96000 are not supported
When the Codec is set to amr, it supports only 8000
When Request.AudioMode is set to MusicMode, this parameter is invalid
String
44100
No
Bitrate
Request.AudioConfig
audio bitrate
Unit: Kbps
Value range: [8, 1000]
When Request.AudioMode is set to MusicMode, this parameter is invalid
String
Original audio bitrate
No
Channels
Request.AudioConfig
number of sound channels
When Codec is set to aac/flac, support 1, 2, 4, 5, 6, 8
When Codec is set to mp3, support 1, 2
When Codec is set to amr, it supports only 1
When Request.AudioMode is set to MusicMode, this parameter is invalid
String
Original number of audio channels
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>NjJmMWQxYjNfOTBmYTUwNjRfNWYyY18x</RequestId>
    <Template>
        <Tag>VoiceSeparate</Tag>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VoiceSeparate>
            <AudioMode>IsAudio</AudioMode>
            <AudioConfig>
                <Codec>mp3</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>12</Bitrate>
                <Channels>2</Channels>
            </AudioConfig>
        </VoiceSeparate>
        <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
Template
Response
Container for saving template details
Container
RequestId
Response
unique request ID
String
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 bucket
String
Category
Response.Template
template property, Custom or Official
String
Tag
Response.Template
Template type: VoiceSeparate
String
UpdateTime
Response.Template
Update time
String
CreateTime
Response.Template
Creation time
String
VoiceSeparate
Response.Template
Detailed template parameters
Container
Container node VoiceSeparate content:
Node Name (Keyword)
Parent Node
Description
Type
AudioMode
Response.Template.VoiceSeparate
Request.AudioMode in the request body
String
AudioConfig
Response.Template.VoiceSeparate
Request.AudioConfig in the request body
Container

Error Code

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

Practical Case

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>VoiceSeparate</Tag>
    <Name>TemplateName</Name>
    <AudioMode>IsAudio</AudioMode>
    <AudioConfig>
        <Codec>aac</Codec>
        <Samplerate>44100</Samplerate>
        <Bitrate>128</Bitrate>
        <Channels>4</Channels>
    </AudioConfig>
</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: NjJmMWQxYjNfOTBmYTUwNjRfNWYyY18x

<Response>
    <RequestId>NjJmMWQxYjNfOTBmYTUwNjRfNWYyY18x</RequestId>
    <Template>
        <Tag>VoiceSeparate</Tag>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VoiceSeparate>
            <AudioMode>IsAudio</AudioMode>
            <AudioConfig>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
            </AudioConfig>
        </VoiceSeparate>
        <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