Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs（Current）
User GuideBack To APP
Api Docs（Current）
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Voice Character
  • 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 Character

Migrate a voice character to v2.0

POST
https://v1.vocu.studio/api/voice/{id}/migrateV2
Migrate a v1.0 voice character to v2.0: rebuild the upstream character, clear each style's old bindings, and finally persist version as v2.0.
Migration is synchronous; returning { status: 200 } means it has been persisted; but each style's binding is lazily rebuilt on the next generate.
Only v1.0 voices need migrating: when version is already not v1.0, VOICE_MIGRATE_NOT_NEEDED is returned.

Sub-code semantics of failure reasons (important)#

This endpoint's failure code has only three values: VOICE_MIGRATE_NOT_NEEDED, VOICE_MIGRATE_NO_SOURCE, VOICE_MIGRATE_NOT_ALLOWED.
Of these, VOICE_MIGRATE_NOT_ALLOWED is a parent code with two different-reason sub-codes under it;
sub-codes only rewrite the message copy and never appear in any field of the HTTP body (modules/errorCodes.js:287-301, composeErrorResponse in modules/routeHelpers.js).
Actual reasonInternal sub-codeHTTP body code
Source or target version is v4.0 (cross model family; needs a separate pipeline; half-migration is refused)noneVOICE_MIGRATE_NOT_ALLOWED
Voice has professional-cloning (LoRA) artifacts; metadata.loraId is presentVOICE_MIGRATE_LORA_VOICEVOICE_MIGRATE_NOT_ALLOWED
Conclusion: the client cannot distinguish these two failures by code; it can only display the already-localized message.
If the product must distinguish them, read the voice's version and metadata.withLora before calling and decide yourself.
VOICE_MIGRATE_NO_SOURCE is an independent parent code, meaning the voice has neither a style list nor usable original reference audio, so there is nothing to rebuild from.
Version values: creatable versions are v2.0 / v3.0 / v4.0; historical voices may still be v1.0 (modules/voiceVersion.js:26,29).
v4.0 capability envelope: no professional cloning / voice cover / test voices; instruct generate path only.
Legacy alias: /api/tts/voice/{id}/migrateV2 — still supported for backward compatibility; use the primary path for new integrations.
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

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//migrateV2' \
--header 'Authorization: Bearer <token>'

Responses

🟢200成功
application/json
迁移完成。响应无 data 字段
Bodyapplication/json

Example
{
    "status": 200
}
🟠400请求有误
🟠401没有权限
🟠404记录不存在
🟠409
🟠429
🔴500服务器错误
Modified at 2026-08-23 01:11:55
Previous
Trigger automatic re-upload of professional-cloning artifacts
Next
Migrate a voice character to v3.0