DesignVoiceAsync

Last updated: 2026-07-02 11:34:32Download PDF

1. API Description

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

This API is used to design a voice. It generates a voice ID based on a prompt. The default maximum number of cloned or designed voices is 100.

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: DesignVoiceAsync.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Prompt	Yes	String	Voice description.
VoiceProfile	No	VoiceProfile	Voice attribute.
Text	No	String	Audition audio text. The length cannot exceed 500.
ExtParam	No	String	Extended parameters in the format of a JSON string.

3. Output Parameters

Parameter Name	Type	Description
ErrorCode	Integer	Error code. 0 is returned if the request is successful.
Msg	String	Error message. success is returned if the request is successful.
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.

4. Example

Example1 Voice Design Example

Input Example

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

{
    "Prompt": "Movie narration male voice, with varied intonation, deep and magnetic."
}

Output Example

{
    "Response": {
        "ErrorCode": 0,
        "Msg": "success",
        "TaskId": "1300057393-DesignVoiceAsync-f255b8b7-82a7-41e1-8e88-b61e247cc510",
        "RequestId": "f255b8b7-82a7-41e1-8e88-b61e247cc510"
    }
}

Example2 Using a Custom Attribute for Voice Design

Input Example

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

{
    "Prompt": "Movie narration male voice, with varied intonation, deep and magnetic.",
    "VoiceProfile": {
        "Name": "design-test",
        "Gender": "male",
        "Age": "middle_aged",
        "Labels": [
            "Magnetic"
        ],
        "Scenes": [
            "Narration"
        ]
    }
}

Output Example

{
    "Response": {
        "ErrorCode": 0,
        "Msg": "success",
        "TaskId": "1300057393-DesignVoiceAsync-57778be2-5fdf-4c2b-b699-15aed0123085",
        "RequestId": "57778be2-5fdf-4c2b-b699-15aed0123085"
    }
}

Example3 Designing a Voice with Audition

Input Example

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

{
    "Prompt": "Movie narration male voice, with varied intonation, deep and magnetic.",
    "VoiceProfile": {
        "Name": "Test preview",
        "Gender": "male"
    },
    "Text": "On a stormy night, the ancient bell tower struck twelve."
}

Output Example

{
    "Response": {
        "ErrorCode": 0,
        "Msg": "success",
        "TaskId": "1300057393-DesignVoiceAsync-0ce1e964-516d-490a-80e2-1c8f574fd493",
        "RequestId": "0ce1e964-516d-490a-80e2-1c8f574fd493"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.