Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)
User GuideBack To APP
Api Docs(Current)
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Voice Generation
  • Overview
  • Authentication Method
  • Voice Character
    • Create a new voice character
      POST
    • Get the list of voice characters for the current user
      GET
    • Add a style to the voice character with the specified ID
      POST
    • Upload avatar for the voice character with the specified ID
      POST
    • Add a voice character to the account via a share ID
      POST
    • Get details of the voice character with the specified ID
      GET
    • Delete Voice Character with the specified ID
      DELETE
    • Get the one-time share link ID for the specified voice character ID
      GET
    • Delete Style of the specified ID for the Voice Character with the specified ID
      DELETE
    • Generate a voice-character preview clip
      POST
    • Update a voice character's name and description
      POST
    • Inspect and backfill missing voice-character fields
      POST
    • Get the transcription of a style's reference audio
      GET
    • Correct the transcription of a style's reference audio
      POST
    • Set a style as the default style
      POST
    • Update a style's name and description
      POST
    • Reset a style and reprocess its reference audio
      POST
    • Re-upload professional-cloning artifacts
      POST
    • Trigger automatic re-upload of professional-cloning artifacts
      POST
    • Migrate a voice character to v2.0
      POST
    • Migrate a voice character to v3.0
      POST
    • Start voice-character identity verification
      POST
    • Check voice-character identity-verification result
      POST
  • Voice Generation
    • Synchronous real-time voice generation
      POST
    • Create Asynchronous Voice Generation Task
      POST
    • Get the list of asynchronous generation tasks for the current user
      GET
    • Get the details of an asynchronous generation task by ID
      GET
    • Delete an asynchronous generation task by ID
      DELETE
    • Upload audio for voice conversion
      POST
    • Stream the full generated audio
      GET
    • Stream audio for a single content
      GET
    • Get the streaming playback URL for a whole generation task
      GET
    • List splitter configurations
      GET
    • Create a splitter configuration
      POST
    • Get splitter configuration details
      GET
    • Update a splitter configuration (diff mode)
      POST
    • Delete a splitter configuration
      DELETE
    • One-shot synthesis returning an MP3 stream directly
      GET
    • List synthesis parameter presets
      GET
    • Fetch a synthesized audio stream
      GET
    • Get SRT subtitles for synthesized audio
      GET
  • User Account
    • Get current user account information
  • Content Template
    • Create New Template
    • Get User's Template List
    • Update Template with Specified ID
    • Get Template Details with Specified ID
    • Delete Template with Specified ID
  • Real-time Synthesis
    • Create a Turbo real-time synthesis channel
    • List Turbo channels for the current user
    • Close a Turbo channel
  • Voice Design
    • Generate a voice preview from a text description
    • Generate a voice preview by remixing / translating existing audio
    • Confirm a voice design and create a voice character
    • Query voice-design quota
  1. Voice Generation

Fetch a synthesized audio stream

GET
https://v1.vocu.studio/api/tts/stream/{id}
Fetch an MP3 audio stream by audio ID. The URL is given directly in the response of POST /api/tts/simple-generate (stream mode) and similar endpoints,
and usually does not need to be assembled by the caller.

Independent auth (Bearer JWT is not used)#

This endpoint is JWT-exempt (app.js:262 already excludes /api/tts/stream/* from the auth middleware),
and instead uses query parameter auth carrying a 32-character static token:
Tokens are issued per user, stored in Redis auth:user:{token}, TTL 7 days; the same user reuses the same token while it is valid
The token itself only resolves to a userId; the audio's ownership is then checked, mismatch returns AUTH_FORBIDDEN
An invalid or expired token returns AUTH_UNAUTHORIZED
Because the credential is in the URL, these addresses can be handed directly to an <audio> tag, a player, or a download tool,
but they should not be written to public logs or used as long-lived share links.

Streaming and range requests#

The same id is fetched from upstream only once on the server; multiple requests (including iOS Range continuation) share one cached session
Range requests are supported (206 Partial Content); an out-of-range offset returns 416; HEAD probes return headers immediately without blocking
An ETag is sent, used with If-Range to prevent concatenating corrupted audio across sessions
When the audio fails before producing any bytes, a standard JSON error body is returned rather than an empty stream:
upstream fetch failure is STREAM_FETCH_FAILED, session exceeding max lifetime is STREAM_TIMEOUT,
instruct_mode synthesis itself failing is TTS_GENERATE_FAILED
Stream metadata TTL is 7 days; after expiry, STREAM_NOT_FOUND is returned

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.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://v1.vocu.studio/api/tts/stream/?auth=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200成功
audio/mpeg
MP3 音频流。完整请求返回 200,带 Range 的请求返回 206
Headers

Bodyaudio/mpeg

Example
{}
🟠400请求有误
🟠401没有权限
🟠403禁止访问
🟠404记录不存在
🟠429
🔴500服务器错误
Modified at 2026-08-23 01:11:55
Previous
List synthesis parameter presets
Next
Get SRT subtitles for synthesized audio