Alibaba Cloud Model Studio:WebSocket connection guide

Access the Qwen-Audio-TTS real-time speech synthesis service through a WebSocket connection. Covers service endpoints, request headers, and the client-server interaction workflow.

Rate limits: Model calls are subject to rate limits. When a limit is exceeded, the server returns the error Requests rate limit exceeded, please try again later. Reduce your request rate or concurrency and retry. For the rate limits of each model, see Rate limiting.

Service endpoints

Fixed WebSocket URL:

Singapore

wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api-ws/v1/inference

Replace {WorkspaceId} with your actual workspace ID.

China (Beijing)

wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference

Replace {WorkspaceId} with your actual workspace ID.

Request headers

Include the following headers in the request:

Parameter	Type	Required	Description
Authorization	string	Yes	Format: Bearer <API key>. Replace <API key> with your API key.
user-agent	string	No	Client identifier for request tracking.
X-DashScope-WorkSpace	string	No	Alibaba Cloud Model Studio workspace ID.
X-DashScope-DataInspection	string	No	Enables data inspection. Default: enable. Leave unset unless required.

Interaction workflow

For details about client-side and server-side events, see Client events and Server-side events.

Client-server interaction sequence:

1. Establish a connection: Create a WebSocket connection to the server.

2. Start a task: Send a run-task event.

3. Wait for confirmation: Receive a task-started event from the server before proceeding.

4. Send text for synthesis:

   Send one or more continue-task events with the text to synthesize, in sequence. The server returns a result-generated event with an audio stream after each complete sentence. For text length limits, see the text field in the continue-task event.

   NoteSend multiple continue-task events with text segments in order. The server splits text into sentences:

   • Complete sentences are synthesized and returned as audio immediately.
   • Incomplete sentences are buffered until complete.

   A finish-task event forces synthesis of all buffered content.

5. Receive audio: Read the audio stream from the binary channel.

6. End the task:

   After sending all text, send a finish-task event and continue receiving audio. This step is mandatory — skipping it may produce incomplete audio.

7. Receive task completion:

   A task-finished event from the server confirms the task is complete.

8. Close the connection: Disconnect the WebSocket.

Reuse the WebSocket connection across tasks instead of creating a new one for each.