tencent cloud

APIs

CreateAigcCustomVoice

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-19 15:03:11

1. API Description

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

This API is used to create custom voice types for AIGC.

A maximum of 20 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: CreateAigcCustomVoice.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId No Integer

Video-on-demand (VOD) application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications, whether it is the default application or a newly created application.

VoiceName No String

Timbre name. The maximum length of the text content is 20 characters.

VoiceUrl No String

Access link for the timbre data file. Supports audio/video files in .mp3 / .wav / .mp4 / .mov format. The voice in the audio should be clean and noiseless, with only one voice type. The duration should be no shorter than 5 seconds and no longer than 30 seconds.

VideoId No String

History works ID. Audio material can be provided by referring to history works.

SessionId No String

Identifier for deduplication. If a request with the same identifier has been sent within the past three days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed.

SessionContext No String

Source context. This is used to pass through user request information. The task complete callback returns the value of this field. The maximum length is 1000 characters.

TasksPriority No Integer

Task priority. The higher the value, the higher the priority. The value ranges from -10 to 10. If left blank, it represents 0.

3. Output Parameters

Parameter Name Type Description
TaskId String

Task ID.

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 custom voice type

Input Example

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

{
    "SubAppId": 221073,
    "VoiceName": "myVoice",
    "VoiceUrl": "myVoiceUrl",
    "VideoId": "myVideoId"
}

Output Example

{
    "Response": {
        "TaskId": "221073-CreateAigcCustomVoice-d5cd48945834b441e6e2db3966d4c954t",
        "RequestId": "daab1385-c7d7-4668-90a0-99f73f14c009"
    }
}

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.
InvalidParameter Parameter error.
InvalidParameterValue.SessionContextTooLong SessionContext is too long.
InvalidParameterValue.SessionId The deduplication ID already exists. The request is removed due to duplication.
InvalidParameterValue.SessionIdTooLong SessionId is too long.
InvalidParameterValue.SubAppId Incorrect parameter value: application id.
UnauthorizedOperation Unauthorized operation.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan