Help Center/ MetaStudio/ API Reference/ Voice Modeling Task Management/ Querying Voice Training Task Details
Updated on 2024-07-04 GMT+08:00

Querying Voice Training Task Details

Function

Queries voice training task details.

Calling Method

For details, see Calling APIs.

URI

GET /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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_type

String

Training type.

  • LLM_MAJOR: LLM in Chinese and English

  • LLM_MINOR: LLM in Chinese and non-Chinese/English languages

  • BASIC: basic edition (20 sentences)

  • MIDDLE: advanced edition (100 sentences)

  • ADVANCE: premium edition

  • THIRD_PARTY: third-party Mobvoi (training edition)

job_id

String

Task ID.

app_user_id

String

User ID.

voice_name

String

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

sex

String

Gender.

  • FEMALE

  • MALE

language

String

Language.

state

String

Task status.

  • CREATING: The task is being created.

  • SYSTEM_AUDITING: The task is being reviewed.

  • AUDITING: The task is being manually reviewed.

  • WAITING: The task is waiting for training.

  • PROCESSING: The task is being trained.

  • RESULT_REVIEW: review result

  • AUDIT_FAILED: The review failed and the system waits for the user to reupload data.

  • FAILED: The task failed.

  • SUCCEED: The task has been completed.

reject_times

Integer

Number of times that the status occurs in the current task.

asset_id

String

ID of the timbre model in the asset library. This parameter is displayed when the task status is successful.

job_failed_code

String

An error code is displayed when a task fails.

job_failed_reason

String

The failure cause is displayed when a task fails.

create_time

Long

Task creation time.

lastupdate_time

Long

Time when the task status is updated.

voice_authorization_url

String

Link to the user's authorization letter.

create_type

String

Task creation mode.

  • PACKAGE: A .zip file contains all data.

  • SEGMENT: Data is uploaded sentence by sentence.

tag

String

Task tag.

  • ECOMMERCE

  • NEWS

  • MARKETING

phone

String

Mobile phone number

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

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

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "job_type" : "BASIC",
  "job_id" : "abcdefg",
  "app_user_id" : "123qwe",
  "voice_name" : "Female voice",
  "sex" : "FEMALE",
  "language" : "CN",
  "state" : "WAITING",
  "asset_id" : "my_asset_id",
  "job_failed_code" : "MSS.00000000",
  "job_failed_reason" : "error reason",
  "create_time" : 2147483647,
  "lastupdate_time" : 2147483647,
  "voice_authorization_url" : "https://bucket/data",
  "create_type" : "PACKAGE",
  "tag" : "ECOMMERCE"
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeded.

400

Abnormal training parameters.

Error Codes

See Error Codes.