Help Center/ MetaStudio/ API Reference/ TTS/ TTS Management/ Verifying Timbre Models (Self-Developed and Third-Party Timbres)
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Verifying Timbre Models (Self-Developed and Third-Party Timbres)

Function

Checks whether the timbre model is available. If the model is available, the model information is returned. If the model is unavailable, the reason why the model is unavailable is returned.

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/check-voice-asset/{voice_asset_id}

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.

voice_asset_id

Yes

String

Timbre asset ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

asset_id

String

Asset ID.

asset_name

String

Asset name.

asset_type

String

Asset type.

Public asset type. Options:

  • VOICE_MODEL: timbre model

asset_state

String

Asset status.

  • CREATING: The asset is being created. The main file has not been uploaded.

  • FAILED: Main file upload failed.

  • UNACTIVED: The main file has been uploaded. The asset is not activated and cannot be used for other services. (Users can update the status.)

  • ACTIVED: The main file has been uploaded. The asset is activated and can be used for other services. (Users can update the status.)

  • DELETING: The asset is being deleted. The asset is unavailable but can be restored.

  • DELETED: The asset has been deleted. The asset is unavailable and cannot be restored.

  • BLOCK: The asset has been frozen. The asset is unavailable and cannot be viewed.

create_time

String

Time when an asset is created.

update_time

String

Time when an asset is updated.

asset_extra_meta

TtscAssetExtraMeta object

Asset metadata. Specify this parameter based on the asset type.

files

Array of TtscAssetFileInfo objects

Files under an asset.
Table 4 TtscAssetExtraMeta

Parameter

Type

Description

voice_model_meta

TtscVoiceModelAssetMeta object

Timbre model metadata.
Table 5 TtscVoiceModelAssetMeta

Parameter

Type

Description

sex

String

Timbre gender. Options:

  • UNKNOW: neutral

  • MALE: male

  • FEMALE: female

The default value is UNKNOW.

Default value:

UNKNOW

external_voice_meta

TtscExternalVoiceAssetMeta object

Third-party TTS timbre metadata.

language

String

Voice language. Options:

  • UNKNOW: unknown

  • CN: Chinese

  • EN: English

  • GER: German

  • fr: French

  • Kr: Korean

  • por: Portuguese

  • JPN: Japanese

  • Ita: Italian

  • ESP: Spanish

  • DBH: Northeast China dialect

  • GT: Hong Kong & Taiwan dialect

  • GXH: Guangxi dialect

  • HBH: Hubei dialect

  • SXH: Shaanxi dialect

  • SCH: Sichuan dialect

  • YY: Cantonese

  • Russian: Russian

  • Filipino: Tagalog

  • Dutch: Dutch

  • Indonesian: Indonesian

  • Vietnamese: Vietnamese

  • Arabic: Arabic

  • Turkish: Turkish

  • Malay: Malay

  • Thai: Thai

  • Finnish: Finnish

The default value is UNKNOW.

Default value:

UNKNOW

speed_ratio

Float

Speaking speed zoom ratio

Value range:

0~100

Default value:

1

volume_ratio

Float

Volume zoom ratio

Value range:

0~100

Default value:

1
Table 6 TtscExternalVoiceAssetMeta

Parameter

Type

Description

provider

String

Third-party TTS vendor. Options:

  • XIMALAYA: Himalaya TTS

  • HUAWEI_EI: EI TTS

  • MOBVOI: DupDub TTS

mobvoi_voice_meta

TtscMobvoiVoiceAssetMeta object

DupDub TTS timbre metadata.

audiox_voice_meta

TtscAudioxVoiceAssetMeta object

AudioX TTS timbre metadata.
Table 7 TtscMobvoiVoiceAssetMeta

Parameter

Type

Description

speaker

String

Specifies the voice for the synthesized speech.
Table 8 TtscAudioxVoiceAssetMeta

Parameter

Type

Description

speaker

String

Specifies the voice for the synthesized speech.
Table 9 TtscAssetFileInfo

Parameter

Type

Description

file_id

String

File ID.

file_name

String

File name, which is case-insensitive during file creation. The value contains 1 to 256 characters.

file_md5

String

MD5 value of the file content. The value must contain 24 characters.

file_size

Long

Total file size. The value ranges from 1 to 5,368,709,120.

Value range:

1~5368709120

file_type

String

File type (the file suffix is extracted by default).

asset_file_category

String

File category in an asset. Each asset type contains different file categories.

  • MAIN: main file

  • COVER: thumbnail file

  • PAGE: content page image

  • SAMPLE: sample audio

  • OTHER: other files

  • WHOLE_MODEL: an entire model

  • USER_MODIFIED_MODEL: model uploaded by a user

NOTE:

  • When the asset type is SCENE, ANIMATION, VIDEO, IMAGE, or MATERIAL, categories are MAIN, COVER, and OTHER.

  • When the asset type is PPT, categories are MAIN, COVER, PAGE, and OTHER.

  • When the asset type is HUMAN_MODEL, categories are MAIN, COVER, and OTHER.

  • When the asset type is VOICE_MODEL, categories are MAIN, SAMPLE (sample audio file), and OTHER.

  • When the asset type is HUMAN_MODEL_2D, categories are MAIN, COVER, SAMPLE (sample action), and OTHER (mask file).

  • When the asset type is BUSINESS_CARD_TEMPLATE, categories are MAIN and COVER (business card demo).

download_url

String

URL for file download. The validity period is 24 hours.

state

String

File status. Options:

  • CREATING: being uploaded

  • CREATED: uploaded (auto approved)

  • FAILED: upload failed

  • CANCELLED: upload cancelled

  • DELETING: being deleted

  • DELETED: deleted

  • UPLOADED: uploaded (not approved yet)

  • REVIEW: manual review (uploaded)

reason

String

Rejection reason.

Status code: 400

Table 10 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 11 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/preload/858153064daf186c36a07802dc859234

Example Responses

None

Status Codes

Status Code

Description

200

Succeeded.

400

Parameter error.

500

Server error.

Error Codes

See Error Codes.

Parent Topic: TTS Management