VoiceClone

1. API Description

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

This API is used to clone sound.

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: VoiceClone.
Version	Yes	String	Common Params. The value used for this API: 2019-07-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
SdkAppId	Yes	Integer	Specifies the SdkAppId of TRTC.
VoiceName	Yes	String	Sound clone name. only digits, letters, and underscores are allowed with a maximum of 36 characters.
PromptAudio	Yes	String	The reference audio for voice cloning must be a base64 string of a 16k mono wav file with length between 10–180 seconds.
PromptText	No	String	Reference text for voice cloning. specifies the text corresponding to the reference audio.
Model	No	String	TTS model: flow_01_turbo, flow_01_ex.
Language	No	String	Language parameter, empty by default. see: (ISO 639-1).

3. Output Parameters

Parameter Name	Type	Description
VoiceId	String	Cloned voice type ID. specifies the ID for performing text to speech.
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 Sound Clone

Input Example

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

{
    "SdkAppId": 1466000000,
    "VoiceName": "xiaoming_02",
    "PromptAudio": "ejxxxxxx"
}

Output Example

{
    "Response": {
        "VoiceId": "xiaoming_02_aidniwqndq",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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

Tencent Cloud CLI 3.0

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
InvalidParameter.AudioPrompt	Invalid reference audio.
InvalidParameter.Pitch	Invalid tone.
InvalidParameter.SampleRate	Invalid sampling rate.
InvalidParameter.Speed	Invalid speed of sound.
InvalidParameter.TextLength	Invalid text length.
InvalidParameter.VoiceId	Invalid VoiceId.
InvalidParameter.VoiceName	Invalid sound name.
InvalidParameter.Volume	Invalid volume.
MissingParameter.APIKey	Invalid api key.
UnsupportedOperation.InternalError	Unsupported operation.
UnsupportedOperation.NotAllowed	Not allowed to use. contact technical personnel.
UnsupportedOperation.VoiceCloneError	Sound clone error.