Help Center/ MetaStudio/ API Reference/ TTS Management/ Obtaining a TTS Preview File
Updated on 2024-07-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining a TTS Preview File

Function

Obtains the download URL of the TTS preview file. The returned list contains the preview file that has been generated.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/ttsc/audition-file/{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-Request-Id

No

String

Request ID, which identifies the request of one stream and is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

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

is_file_complete

Boolean

Whether the preview file has been generated. If this parameter is set to false, this API needs to be called every 5 seconds to obtain the preview file.

message

String

Error message.

files

Array of AuditionFile objects

List of preview files.
Table 4 AuditionFile

Parameter

Type

Description

download_url

String

Link for downloading a preview file. The validity period is one hour.

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/audition-file/a60fe9d851f84036a5b7cfc3b0c1339e

Example Responses

Status code: 200

Succeeded.

{
  "is_file_complete" : true,
  "files" : [ {
    "download_url" : "https://aaa"
  }, {
    "download_url" : "https://bbb"
  } ]
}

Status Codes

Status Code

Description

200

Succeeded.

400

Invalid parameter.

500

Server error.

Error Codes

See Error Codes.

Parent Topic: TTS Management