Skip to main content
Qwen-Audio-TTS

Qwen-Audio-TTS server-side events

task-started

After the client sends the run-task command, the server returns a task-started event to signal that the task has started. The client can send subsequent commands only after receiving this event.
header.task_id stringThe task ID generated by the client.header.event stringEvent type. Fixed value: task-started.payload objectEmpty object.
{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "task-started",
    "attributes": {}
  },
  "payload": {}
}

result-generated

After the client sends text, the server continuously returns result-generated events. Each event carries sentence-level metadata.
header.task_id stringThe task ID generated by the client.header.event stringEvent type. Fixed value: result-generated.payload.output objectOutput information.

Properties

type stringSub-event type. Valid values:
  • sentence-begin: Sentence start. Returns the text to be synthesized.
  • sentence-synthesis: Marks an audio frame. One audio frame is transmitted over the WebSocket binary channel immediately after each event.
  • sentence-end: Sentence end. Returns the text content and usage information (usage).
sentence.index integerSentence index, starting from 0.sentence.words arrayWord-level timestamp array.

words element properties

text stringText content of the word.begin_index integerStart character index of the word within the sentence. Starts at 0.end_index integerEnd character index of the word within the sentence. Starts at 1.begin_time integerStart time of the word's corresponding audio, in milliseconds.end_time integerEnd time of the word's corresponding audio, in milliseconds.
original_text stringText of the sentence as segmented for synthesis.
payload.usage objectBilling usage, returned in the sentence-end event.

Properties

input_tokens integerInput token count for this request.
Applies to qwen-audio-3.1-tts-flash.
output_tokens integerOutput token count for this request.
Applies to qwen-audio-3.1-tts-flash.
total_tokens integerSum of input and output tokens.
Applies to qwen-audio-3.1-tts-flash.
characters integerCumulative number of billed characters.
Applies to qwen-audio-3.0-tts-plus and qwen-audio-3.0-tts-flash.
{
  "header": {
    "task_id": "3f2d5c86-0550-45c0-801f-xxxxxxxxxx",
    "event": "result-generated",
    "attributes": {}
  },
  "payload": {
    "output": {
      "sentence": {
        "index": 0,
        "words": []
      },
      "type": "sentence-begin",
      "original_text": "Before my bed, moonlight shines bright,"
    }
  }
}

task-finished

The server returns a task-finished event when the task completes. The client can then close the WebSocket connection or reuse it to start a new task.
header.task_id stringThe task ID generated by the client.header.event stringEvent type. Fixed value: task-finished.payload.usage objectThe fields are the same as usage in result-generated.
{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "task-finished",
    "attributes": {
      "request_uuid": "0a9dba9e-d3a6-45a4-be6d-xxxxxxxxxxxx"
    }
  },
  "payload": {
    "usage": {
      "characters": 13
    }
  }
}

task-failed

The server returns a task-failed event when the task fails. On receiving this event, the client must close the WebSocket connection and handle the error.
header.task_id stringThe task ID generated by the client.header.event stringEvent type. Fixed value: task-failed.header.error_code stringError code.header.error_message stringDetailed error message.
{
  "header": {
    "task_id": "2bf83b9a-baeb-4fda-8d9a-xxxxxxxxxxxx",
    "event": "task-failed",
    "error_code": "InvalidParameter",
    "error_message": "[tts:]Engine return error code: 418",
    "attributes": {}
  },
  "payload": {}
}
API Usage
Text Generation
Image Generation
  • FAQ
Video Generation
World models
Audio
Real-time Multimodal
Realtime API
Text Embedding
Decision Model
More Models
Toolkit/Framework
TokenPlan
Model Production
File Management
Billing
Model Management
More