Help Center/ MetaStudio/ API Reference/ TTS/ Asynchronous TTS Task Management/ Creating a TTS Preview Task
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a TTS Preview Task

Function

Generates an audio file to preview the content to be read by the virtual avatar.

.

Third-party timbre preview is charged. For details about the billing standard, see https://marketplace.huaweicloud.com/intl/contents/939bf377-3005-472b-a4e2-383911e6102f.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/ttsc/audition

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Request-Id

No

String

Request ID, which identifies the request of one stream and is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

text

Yes

String

Text to be composited.

tts_text

No

String

Text to be sent for TTS.

emotion

Yes

String

Timbre ID. For details about how to obtain a timbre ID, see Obtaining a Timbre ID.

speed

No

Integer

Speaking speed.

  • The value 100 indicates the normal speaking speed of an adult, which is about 250 words per minute.

  • 50 indicates 0.5x speaking speed, 100 indicates normal speaking speed, and 200 indicates 2x speaking speed.

Value range:

50~200

Default value:

100

pitch

No

Integer

Pitch.

Value range:

50~200

Default value:

100

volume

No

Integer

Volume.

Value range:

90~240

Default value:

140

business_type

No

String

Service scenario where the preview API is called by multiple entries.

Default value:

N/A

style

No

String

Style and emotion

Default value:

N/A

channels

No

Integer

Audio channel (mono | stereo)

The value ranges from 1 to 2 and defaults to 1.

Value range:

1~2

Default value:

1

is_vocabulary_config_enable

No

Boolean

Whether to apply the pronunciation configuration of the current tenant.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Return code.

  • MSS.000000001: failure

  • MSS.000000002: internal error

  • MSS.000000003: invalid parameter

  • MSS.000000004: invalid access. The access is not authenticated or fails to be authenticated.

error_msg

String

Return result description

request_id

String

Unique ID of the request.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Return code.

  • MSS.000000001: failure

  • MSS.000000002: internal error

  • MSS.000000003: invalid parameter

  • MSS.000000004: invalid access. The access is not authenticated or fails to be authenticated.

error_msg

String

Return result description

request_id

String

Unique ID of the request.

Example Requests

POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/audition

{
  "text" : "Hello, everyone. I'm Sarah.",
  "emotion" : "376f46b0a21e435f92247a6e9f82857f",
  "speed" : 100,
  "pitch" : 100,
  "volume" : 140
}

Example Responses

Status code: 200

Succeeded.

{
  "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}

Status Codes

Status Code

Description

200

Succeeded.

400

Invalid parameter.

500

Server error.

Error Codes

See Error Codes.

Parent Topic: Asynchronous TTS Task Management