Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)
User GuideBack To APP
Api Docs(Current)
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Voice Design
  • 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
    • Create Asynchronous Voice Generation Task
    • Get the list of asynchronous generation tasks for the current user
    • Get the details of an asynchronous generation task by ID
    • Delete an asynchronous generation task by ID
    • Upload audio for voice conversion
    • Stream the full generated audio
    • Stream audio for a single content
    • Get the streaming playback URL for a whole generation task
    • List splitter configurations
    • Create a splitter configuration
    • Get splitter configuration details
    • Update a splitter configuration (diff mode)
    • Delete a splitter configuration
    • One-shot synthesis returning an MP3 stream directly
    • List synthesis parameter presets
    • Fetch a synthesized audio stream
    • Get SRT subtitles for synthesized audio
  • 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
      POST
    • Generate a voice preview by remixing / translating existing audio
      POST
    • Confirm a voice design and create a voice character
      POST
    • Query voice-design quota
      GET
  1. Voice Design

Generate a voice preview by remixing / translating existing audio

POST
https://v1.vocu.studio/api/voice/design/remix
Using an existing audio clip as reference, generate a remixed voice preview. Session, quota, concurrency, and billing rules are identical to "generate a voice preview from a text description".

Two modes#

remix_modeMeaninginstructlanguage
normal (default)Remix the reference audio's timbre per the descriptionrequired (1 ~ 2048 characters)optional, not validated
translateKeep the timbre; translate the reference audio and dub it into the target languageignoredrequired, and must not be auto
language in translate mode is strictly validated: it must be one of the 9 values in auto / zh / en-us / ja / ko / fr-fr / pt / de / es / yue
except auto, otherwise VALIDATION_BAD_PARAMS.
Short aliases are normalized first (en → en-us, fr → fr-fr, modules/validationConstants.js:103-112), so both spellings pass.

Audio source: pick one of two#

At least one of voiceId (+ optional promptIdx) and source_audio_url must be provided; providing neither returns VALIDATION_BAD_PARAMS.
source_audio_url only accepts a data: URL or an http(s) address whose domain has been allowlisted by ops; anything else is always VALIDATION_BAD_PARAMS.

Many optional tuning parameters#

The parameters below all accept both camelCase and snake_case spellings, and follow the same tolerance rule:
out-of-range or wrong-type values are silently dropped and fall back to server defaults; they do not error.
This is intentional (these parameters are purely additive capability), but it also means a misspelled parameter name produces no hint — check against this document.

Error-code downgrade notes#

When resolving the reference voice fails, only VOICE_NOT_FOUND is passed through as-is;
an unpurchased market voice (internal MARKET_VOICE_NOT_FOUND) and lack of access (internal AUTH_FORBIDDEN)
are not on the passthrough allowlist (modules/routeHelpers.js:1008) and both end up downgraded to 500 SYSTEM_INTERNAL_ERROR.
This endpoint has a single path; there is no /api/tts/voice/... compatibility alias.

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

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 --request POST 'https://v1.vocu.studio/api/voice/design/remix' \
--header 'Authorization: Bearer <token>'

Responses

🟢200成功
application/json
改造试听生成成功,sessionId 用于后续确认
Bodyapplication/json

Example
{
    "status": 200,
    "data": {
        "sessionId": "6b0e94d3-1c72-4a85-b3f6-08de5217ca49",
        "previewAudioUrl": "https://storage.vocu.ai/voice-design/2f81b40c-9d63-4e17-a5b8-31c7d0e926af/6b0e94d3-1c72-4a85-b3f6-08de5217ca49-remix.wav",
        "text": "Hello, nice to meet you. I hope we work well together.",
        "remix_mode": "translate",
        "no_content": false,
        "source_tags": [
            "speech"
        ]
    }
}
🟠400请求有误
🟠401没有权限
🟠403禁止访问
🟠404记录不存在
🟠429
🔴500服务器错误
Modified at 2026-08-23 01:11:55
Previous
Generate a voice preview from a text description
Next
Confirm a voice design and create a voice character