Domain name for API request: vod.intl.tencentcloudapi.com.
Initiate a speech synthesis task to convert text to speech for long text scenarios (up to 200,000 characters). It supports specifying voice tone, speaking rate, volume, pitch, sampling rate, output format, and other synthesis parameters. Speech synthesis is an asynchronous task, and audio results are generated upon 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: TextToSpeechAsync. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Text | Yes | String | Text to convert to speech. |
| VoiceId | Yes | String | Voice ID. |
| SubAppId | No | String | VOD application ID. For customers who activate on-demand services after December 25, 2023, this field must be set to the application ID when accessing resources in on-demand applications, whether in the default application or a newly created application. |
| LanguageBoost | No | String | Language enhancement, such as "zh" "en" "auto", default "auto" |
| ExtParam | No | String | Extended parameters for text-to-synthesized speech (async). Fields supported by ExtParam:
|
| Output | No | TextToSpeechAsyncOutputOption | Output parameters. Specifies the output format, etc. The default output audio format is url. |
| SessionContext | No | String | Identifies source context. This is used to pass user request information. The callback and task flow status change callback 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 made 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. Use this ID to query the result. |
| 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. |
Text to speech
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TextToSpeechAsync
<Common request parameters>
{
"Text": "Text to Speech Test"
"VoiceId": "ttv-voice-20************26-qaFeULIp",
"SubAppId": "260***028",
"SessionId": "6bb56a09278***********6dab783eff"
}{
"Response": {
"TaskId": "260085028-TextToSpeec********************5b37f06c0e0b890c60ct",
"RequestId": "e6dd5ca8-43f2-4bcd-9f4a-4e58e4cb4e19"
}
}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.
文档反馈