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

Obtaining an Asynchronous TTS Task

Function

Obtains the download URL of a TTS audio file.

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

GET /v1/{project_id}/ttsc/async-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 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

When the status code is 200, the response may be successful, as shown in Table 3; or it may be a failure, as also shown in Table 4.

Table 3 Response body parameters

Parameter

Type

Description

state

String

Whether the audio file has been generated. If this parameter is set to PROCESSING, this API needs to be called every 3 seconds to obtain the audio file (WAITING, PROCESSING, SUCCEED, and FAILED). If this parameter exists, the URLs for downloading the following files will be returned.

audio_file_url

String

Link for downloading an audio file. The validity period is one hour.

audio_info_file_url

String

Link for downloading an audio information file. The validity period is one hour.

audio_srt_file_url

String

URL for downloading a subtitle file. The validity period is one hour.

audio_action_file_url

String

URL for downloading an action information file. The validity period is one hour.
Table 4 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: 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

GET https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/async-jobs/1742255d667f46b9816d3aed0174a3e1

Example Responses

Status code: 200

Succeeded.

{
  "state" : "SUCCEED",
  "audio_file_url" : "https://xxx"
}

Status Codes

Status Code

Description

200

Succeeded.

400

Parameter error.

500

Server error.

Error Codes

See Error Codes.

Parent Topic: Asynchronous TTS Task Management