Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)User GuideBack To APP
Api Docs(Current)User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Voice Generation
  • Overview
  • Authentication Method
  • Voice Character
    • Create a new voice character
      POST
    • 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 the list of voice characters for the current user
      GET
    • Get details of the voice character with the specified ID
      GET
    • Get the one-time share link ID for the specified voice character ID
      GET
    • Delete Voice Character with the specified ID
      DELETE
    • Delete Style of the specified ID for the Voice Character with the specified ID
      DELETE
  • 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
  • User Account
    • Get current user account information
      GET
  • Content Template
    • Create New Template
      POST
    • Update Template with Specified ID
      POST
    • Get User's Template List
      GET
    • Get Template Details with Specified ID
      GET
    • Delete Template with Specified ID
      DELETE
  1. Voice Generation

Get the details of an asynchronous generation task by ID

GET
https://v1.vocu.ai/api/tts/generate/{id}

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 --request GET 'https://v1.vocu.ai/api/tts/generate/?stream' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Successfully retrieved asynchronous generation task details
application/json
Body

Example
{
    "status": 200,
    "message": "OK",
    "data": {
        "id": "71f2d625-b99c-4654-9d24-337e18b2e3fd",
        "userId": "76609c5e-53b8-4f4f-8d5c-839b5644a910",
        "status": "generated",
        "type": "vocu-neural-voice-001",
        "metadata": {
            "contents": [
                {
                    "voiceId": "5d040784-cc81-4459-aa1d-6c2168ddb845",
                    "text": "A simple banana pie. No fancy stuff. Just pie.",
                    "audio": "https://storage.vocu.ai/generate/d8dd76c1-41a9-44fb-925c-8757b3fdd514/2dbda2bb-5d7e-43f0-a3df-490d99ee2f32-25.mp3",
                    "generatedAt": "1946-10-23T17:07:23.749Z",
                    "preset": "balance",
                    "break_clone": true,
                    "language": "auto",
                    "vivid": false,
                    "emo_switch": [
                        0,
                        0,
                        0,
                        0,
                        0
                    ],
                    "speechRate": 1,
                    "flash": false,
                    "stream": false,
                    "seed": -1
                }
            ],
            "characters": 71,
            "voices": [
                {
                    "id": "3076236f-5997-4aa1-a3ad-a90299023072",
                    "name": "Alvin Schulist",
                    "status": "lora-success",
                    "metadata": {
                        "avatar": "https://picsum.photos/seed/6Q4nigq/1090/1383",
                        "description": "veteran",
                        "prompts": [
                            {
                                "id": "67dde895-bf07-4d07-8b7b-8c13b4f9d794",
                                "name": "thorough",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/549994/384128-playback-vwu5sw.mp3",
                                "playBackAudio": "https://storage.vocu.ai/prompt/833000/424373-playback-4qezbk.mp3",
                                "description": "eminent的情感风格",
                                "language": "auto",
                                "vocalFilter": true
                            },
                            {
                                "id": "304613bd-a7c1-4d5a-b628-2de5f390cf50",
                                "name": "calculating",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/785269/972304-playback-mamvfw.mp3",
                                "playBackAudio": "https://storage.vocu.ai/prompt/250415/359866-playback-zweh13.mp3",
                                "description": "ill-fated的情感风格",
                                "language": "auto",
                                "vocalFilter": true
                            }
                        ]
                    },
                    "version": "v3.0",
                    "from": "upload"
                }
            ],
            "isPremium": false,
            "audio": "https://storage.vocu.ai/generate/6b4a0f6e-20f1-4c0c-b981-bb8191ec9cc3/076d704c-5315-4fdd-be55-340af9468c9e-merged.mp3",
            "generatedAt": "2001-04-01T13:27:08.841Z",
            "srt": false
        }
    }
}
🟠404Asynchronous generation task with the specified ID not found
Modified at 2025-11-09 12:11:15
Previous
Get the list of asynchronous generation tasks for the current user
Next
Delete an asynchronous generation task by ID