Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)
User GuideBack To APP
Api Docs(Current)
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Manage
  • Overview
  • Authentication Method
  • Core
    • Voice Character
      • Manage
        • Get the list of voice characters for the current user
          GET
        • Get details of the voice character with the specified ID
          GET
        • Create a new voice character
          POST
        • Update a voice character's name and description
          POST
        • Upload avatar for the voice character with the specified ID
          POST
        • Delete Voice Character with the specified ID
          DELETE
      • Styles
        • Get the transcription of a style's reference audio
        • Add a style to the voice character with the specified ID
        • Correct the transcription of a style's reference audio
        • Update a style's name and description
        • Set a style as the default style
        • Reset a style and reprocess its reference audio
        • Delete Style of the specified ID for the Voice Character with the specified ID
    • Voice Generation
      • Async jobs
        • Get the list of asynchronous generation tasks for the current user
        • Get the details of an asynchronous generation task by ID
        • Create Asynchronous Voice Generation Task
        • Upload audio for voice conversion
        • Delete an asynchronous generation task by ID
      • Synchronous
        • List synthesis parameter presets
        • One-shot synthesis returning an MP3 stream directly
        • Synchronous real-time voice generation
  • Creative
    • Templates
      • Get User's Template List
      • Get Template Details with Specified ID
      • Create New Template
      • Update Template with Specified ID
      • Delete Template with Specified ID
  • Account
    • User
      • Get current user account information
  • Advanced
    • Splitter
      • List splitter configurations
      • Get splitter configuration details
      • Create a splitter configuration
      • Update a splitter configuration (diff mode)
      • Delete a splitter configuration
  • Schemas
    • Generation Template
    • Generation Task
    • Voice Character
    • General Generation Parameters (New)
    • ErrorResponse
  1. Manage

Get details of the voice character with the specified ID

GET
https://v1.vocu.ai/api/voice/{id}
id may be the UUID of a self-created voice or the id of a purchased market voice. Both spellings of the latter work — prefixed market:<uuid> or bare <uuid> — because the lookup falls back to purchased market voices when no owned voice matches. Market voices you have not bought always return VOICE_NOT_FOUND, so their existence is not disclosed.
When the voice is in lora-awaiting, the response may carry an extra needPollingVerify: true, meaning training resumes only after the user completes voiceprint verification.
This endpoint applies no status filter — creating, failed and lora-pending are all returned. To decide whether the voice can be used for generation, check whether status is one of lora-success, pending, lora-awaiting-auto-reupload.
INFO
Deprecated alias: /api/tts/voice/{id}. See the site document "Versions and migration".
INFO
See the Errors document for the full code reference. Always use the X-Vocu-App-Request-Id response header when troubleshooting.

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 'https://v1.vocu.ai/api/voice/' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Successfully retrieved voice character details
application/json
Voice details
Bodyapplication/json

Example
{
    "status": 200,
    "message": "OK",
    "data": {
        "id": "9f011950-f143-4eb7-abbb-90e0b66874ea",
        "idForGenerate": "53dfa5aa-93e8-40b5-a5ea-2055ce885012",
        "name": "Zhen Xia",
        "status": "lora-success",
        "metadata": {
            "avatar": "https://loremflickr.com/3764/3840?lock=5788646566085736",
            "description": "A great coach",
            "prompts": [
                {
                    "id": "66c052e8-d395-42f1-bb81-dc7325d56430",
                    "name": "Relaxed",
                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/253308/726038-playback-xluat9.mp3",
                    "description": "Relaxed emotional style"
                },
                {
                    "id": "3fb2c923-7dd1-459a-9cc2-67b3a8dd3d9e",
                    "name": "Happy",
                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/047156/753432-playback-9z7f93.mp3",
                    "description": "Happy emotional style"
                },
                {
                    "id": "b98c3886-6581-4674-8145-2ce20ef1b72c",
                    "name": "Brave",
                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/425833/754481-playback-iiejro.mp3",
                    "description": "Brave emotional style"
                }
            ]
        }
    }
}
🟠401Unauthorized
🟠404Not found
🟠429Rate limited
Modified at 2026-08-23 09:24:46
Previous
Get the list of voice characters for the current user
Next
Create a new voice character