Help Center/ MetaStudio/ API Reference/ TTS/ TTS Management/ Obtaining TTS Task Records

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

Online Debugging

CLI Examples

View PDF

Obtaining TTS Task Records

Function

Obtains TTS task records.

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of items displayed on each page. Value range: 1~100 Default value: 10
offset	No	Integer	Offset where the query starts. Value range: 0~2147483647 Default value: 0
create_since	No	String	Filter the records whose creation time is not earlier than the entered time.
create_until	No	String	Filter the records whose creation time is not later than the entered time.
job_id	No	String	Task ID.
job_type	No	String	Task type. AUDITION: audition task ASYNC_JOB: asynchronous task WEBSOCKET: synthesis task by calling the WebSocket API
tts_service_enum	No	String	TTS version. TTS_LLM: 530 large model (V7) TTS_LLM_VC: 530 large model VC version (V7) TTS_LAB: lab small model (V5) TTS_LAB_GPU: lab small model GPU version (V5) GPU_CLONE: V4 model TTS_LLM_VQ: VQ model (V10)
business_type	No	String	Service type.

Request Parameters

**Table 3** 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

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number of records. Value range: 0~2147483647
data	Array of TtsJobDetail objects	List of voice synthesis tasks.

**Table 5** TtsJobDetail
Parameter	Type	Description
job_id	String	Task ID.
websocket_job_id	String	WebSocket task ID.
asset_id	String	Timbre ID.
tts_service_enum	String	Voice version.
text_length	Integer	Text length. Value range: 1~10000
create_time	String	Time when a task was created.
audio_format	String	Output audio file format. The default value is WAV. WAV MP3 PCM Default value: WAV
need_timestamp	Boolean	Whether a timestamp needs returning. false: no; true: yes. Default value: false Default value: false
gen_srt	Boolean	Whether to enable subtitling.
job_type	String	Task type. PRELOAD: preloading task WEBSOCKET: WebSocket API task ASYNC_JOB: asynchronous task AUDITION: audition task
job_state	String	Task status. WAITING: The task is waiting for execution. PROCESSING: synthesizing FAILED: synthesis failed SUCCEED: synthesis succeeded
fail_msg	String	Task synthesis error message.
files	Array of TtsJobFile objects	List of task synthesis files.

**Table 6** TtsJobFile
Parameter	Type	Description
audio_file_url	String	URL for downloading an audio file. The validity period is one hour.
audio_info_file_url	String	URL for downloading a timestamp 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 analysis file. The validity period is one hour.

Status code: 400

**Table 7** 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 8** 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/tts-jobs

Example Responses

Status code: 200

Succeeded.

{
  "count" : 1,
  "data" : [ {
    "asset_id" : "98263xxxxxx34253880a6ff431xxxxxx",
    "text_length" : 3492,
    "job_type" : "WEBSOCKET",
    "job_state" : "SUCCEED",
    "files" : [ {
      "audio_file_url" : "https://xxx"
    } ]
  } ]
}