Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to initiate a voice design task. It generates a custom voice based on a natural language description. You can specify a voice profile at the same time, including name, gender, age, language, tag, and scenario. If trial text is attached during submission, audio audition is generated after task completion. Voice design is an asynchronous task. The voice ID is generated after task completion.
A maximum of 20 requests can be initiated per second for this API.
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: DesignVoiceAsync. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Prompt | Yes | String | Voice description. |
| SubAppId | No | String | VOD application ID. From December 25, 2023, customers who activate on-demand services must fill in this field with the app ID when accessing resources in VOD applications, whether it is the default application or a newly created application. |
| VoiceSettings | No | VoiceSettings | Voice settings |
| PreviewText | No | String | Audition synthetic text, up to 500 characters |
| ExtParam | No | String | Extended parameters in the format of a JSON string. |
| SessionContext | No | String | Identifies the source context. This is used to pass through user request information. The callback and task flow status change callback will return the value of this field. The maximum length is 1000 characters. |
| SessionId | No | String | Identification Code for Task Deduplication. If a request with the same identification code has been sent within the past 3 days, an error will be returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, it indicates no deduplication. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID, used when querying a task. |
| 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. |
Timbre design
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DesignVoiceAsync
<Common request parameters>
{
"SubAppId": "221157",
"Prompt": "Serious female voice",
"VoiceSettings": {
"Name": "Voice Design",
"Description": "Voice type design description",
"Gender": "female",
"Age": "child"
},
"PreviewText": "API send requests are equivalent to real operations. Proceed with caution"
}{
"Response": {
"TaskId": "221157-DesignVoiceAsync-7b6d025eb99dcdb9d4eeb6828c6847fdt",
"RequestId": "5524f480-7bf7-4816-a643-84c28a677c5a"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback