Get the streaming playback URL for a whole generation task

Does not return audio; returns only JSON containing a complete stream.mp3 URL that can be handed to a player (static token and version already attached).
The role is a "URL lookup" endpoint: the client takes data.url and then issues the playback request itself.

Response branches

The generation task's metadata.audio already exists → data.url is the storage URL of the finished audio.

Task status is processing → data.url is the assembled streaming address: {STREAM_URL}/api/tts/generate/{id}/stream.mp3?auth={static token}&i={version}.

Any other status (including generated) → JSON error STREAM_NOT_READY.

Auth differs from the sibling endpoints

This path does not have a .mp3 suffix, so it does not match the allowlist regex at app.js:261; express-jwt and API-key middleware apply normally:
Bearer JWT or an API key is required; the ?auth= static token is not valid here.

Error responses take the shape { status, code, message, requestId? }. code is always the parent code — sub codes only change message and never appear in the body. requestId is present only on reportable-tier errors, so use the X-Vocu-App-Request-Id response header when troubleshooting (it is written unconditionally on every response). See the "Errors" document for the full code reference.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200成功

application/json

获取成功

Bodyapplication/json

Example

{
    "status": 200,
    "data": {
        "url": "https://stream.vocu.ai/api/tts/generate/3f2a1b6c-8d4e-4f27-9a10-5c7e2d81b043/stream.mp3?auth=Kq3mZt9RfW1sJc7xBv0aLp5UnH2eYd6G&i=a7Kd2Rm9"
    }
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠429

Get the streaming playback URL for a whole generation task

Request

Request Code Samples

Responses