Updated on 2024-07-04 GMT+08:00

Submitting a Voice Training Task

Function

This API is used to submit a training task. After this API is called, task review starts. After the review is complete, the model waits for training.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/voice-training-manage/user/jobs/{job_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.

job_id

Yes

String

Task 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 the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

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

tag

No

String

Task tag.

  • ECOMMERCE

  • NEWS

  • MARKETING

description

No

String

Description, which is displayed in the asset library.

sex

No

String

Voice gender, which can be male or female.

  • FEMALE

  • MALE

voice_name

No

String

Timbre name, which is used as the name of the timbre model asset in the asset library.

language

No

String

Training language. Currently, only Chinese is supported.

  • CN: Chinese

  • EN: English

phone

No

String

Mobile phone number

app_user_id

No

String

Third-party user ID

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/voice-training-manage/user/jobs/26f06524-4f75-4b3a-a853-b649a21aaf66

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Abnormal training parameters.

Error Codes

See Error Codes.