Updated on 2025-12-08 GMT+08:00

Creating a Short Task

Function

Creates a short task (such as audio quality assessment). This API returns an OBS URL for uploading voice files.

After the files are uploaded, call the API for submitting a short task to start the task.

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}/voice-training-manage/user/short-jobs

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-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

job_type

Yes

String

Short task type.

  • VOICE_ASSESS: voice quality assessment

language

No

String

Language.

  • CN: Chinese

  • EN: English

Default value:

CN

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

data_uploading_url

String

URL for uploading training data. The training data must be compressed into a .zip file and then uploaded to the URL.

NOTE:
Set content-type to application/zip when uploading files to the OBS URL.

Status code: 400

Table 5 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/short-jobs

{
  "job_type" : "VOICE_ASSESS"
}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
  "data_uploading_url" : "https://my-bucket/data.zip"
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

400

Parameter error.

Error Codes

See Error Codes.