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
  • Low latency WebSocket real-time generation
  • Voice character
    • Create new voice character
      POST
    • Add style to voice character with specified ID
      POST
    • Upload avatar for voice character with specified ID
      POST
    • Add voice character to account via share ID
      POST
    • Get current user's voice character list
      GET
    • Get voice character details for specified ID
      GET
    • Get one-time share link ID for specified voice character ID
      GET
    • Delete voice character with specified ID
      DELETE
    • Delete specified ID style of voice character with specified ID
      DELETE
  • Voice generation
    • Synchronous real-time voice generation
      POST
    • Create asynchronous voice generation task
      POST
    • Regenerate asynchronous generation task for specified ID
      POST
    • Simple streaming voice generation
      GET
    • Get current user's asynchronous generation task list
      GET
    • Get asynchronous generation task details for specified ID
      GET
    • Delete asynchronous generation task with specified ID
      DELETE
  • User account
    • Get current user account information
      GET
  • File management
    • Create chunked upload file for subsequent professional cloning use
      POST
    • Upload chunk file
      POST
    • Complete file chunked upload
      POST
    • Simple file upload
      POST
  • Content template
    • Create new template
      POST
    • Update template with specified ID
      POST
    • Get user's template list
      GET
    • Get template details for specified ID
      GET
    • Delete template with specified ID
      DELETE
  1. Voice generation

Get asynchronous generation task details for specified 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 obtained asynchronous generation task details
application/json
Body

Example
{
    "status": 200,
    "message": "OK",
    "data": {
        "id": "3b20ed32-73bc-421b-8077-62e03b6c5836",
        "userId": "fb225d50-e0ac-4b7f-b32f-4df694bcf4c9",
        "status": "generated",
        "type": "vocu-neural-voice-001",
        "metadata": {
            "contents": [
                {
                    "voiceId": "d5a65b33-e709-4d23-b6a4-06d16b09a2e9",
                    "text": "A succulent chicken steak, encased in a bitter spearmint crust, served with a side of cayenne pepper mashed green pepper.",
                    "audio": "https://storage.vocu.ai/generate/23c3225d-875f-4add-90f7-6189c19b677d/3b145c56-394c-4e13-9dbc-a173f616570e-18.mp3",
                    "generatedAt": "2008-07-24T19:00:50.923Z"
                },
                {
                    "voiceId": "c6d21734-8be7-4d6b-a11f-bb6d63ced440",
                    "text": "Grilled quail kebabs, marinated in Berber spices and served with a fresh bean shoots and longan salad.",
                    "audio": "https://storage.vocu.ai/generate/b630a6bb-a9cf-48be-9a88-024989fa8c73/9ded4b36-53d7-4114-a468-3974ee425383-19.mp3",
                    "generatedAt": "1954-11-16T09:59:44.380Z"
                }
            ],
            "characters": 65,
            "voices": [
                {
                    "id": "2dc7dbac-0313-4499-a630-649cea847bba",
                    "idForGenerate": "6fd9981d-e0fe-4ce0-8245-c7c490f9d40a",
                    "name": "Alison Ruecker",
                    "status": "pending",
                    "metadata": {
                        "avatar": "https://picsum.photos/seed/1oItD4/25/2754",
                        "description": "developer, engineer",
                        "prompts": [
                            {
                                "id": "e9d70889-d5c3-4193-87e0-f8ba1a92947a",
                                "name": "insidious",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/608614/028116-playback-s97elq.mp3",
                                "description": "tinted emotional style"
                            },
                            {
                                "id": "8a12d60a-f93d-47d7-9f18-9cb9f3af2a46",
                                "name": "sophisticated",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/781045/257869-playback-hgt3jy.mp3",
                                "description": "likable emotional style"
                            },
                            {
                                "id": "bf55c61d-8d72-4534-8cca-e5c96f74af79",
                                "name": "red",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/422417/452649-playback-r7ismb.mp3",
                                "description": "first emotional style"
                            }
                        ]
                    }
                },
                {
                    "id": "b7a0e590-9510-442d-8939-db003a36d3ea",
                    "idForGenerate": "649b003d-adca-49ec-ac22-1329efa7b2ce",
                    "name": "Minnie Conroy",
                    "status": "lora-pending",
                    "metadata": {
                        "avatar": "https://picsum.photos/seed/2YqUAYU/1895/727",
                        "description": "inventor, business owner, student",
                        "prompts": [
                            {
                                "id": "88768b5f-2583-4bb3-8e59-39066fe1647a",
                                "name": "gloomy",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/938237/377181-playback-7cqf1b.mp3",
                                "description": "buttery emotional style"
                            },
                            {
                                "id": "e62dd7d7-8190-49ed-9fd1-1b081ce8a8c3",
                                "name": "sudden",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/396717/058895-playback-d6yf0u.mp3",
                                "description": "next emotional style"
                            }
                        ]
                    }
                },
                {
                    "id": "775ec7d8-7c9c-45f3-8e49-fc2298db9c75",
                    "idForGenerate": "e01ccf29-1d84-41b7-90cc-280fc6412212",
                    "name": "Gene Stokes PhD",
                    "status": "lora-failed",
                    "metadata": {
                        "avatar": "https://loremflickr.com/3867/1148?lock=277306157642606",
                        "description": "honesty fan, model 🍮",
                        "prompts": [
                            {
                                "id": "1f8f5a31-f164-4343-83da-ca6c1308f4fe",
                                "name": "charming",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/801090/912892-playback-q7ekrw.mp3",
                                "description": "known emotional style"
                            }
                        ]
                    }
                }
            ],
            "temperature": 0.9009920772744913,
            "top_k": 98,
            "top_p": 0.07344103529169999,
            "isPremium": false,
            "audio": "https://storage.vocu.ai/generate/7dc92d9d-b408-4f16-ba4f-f1a08de5a832/1f0d5ce6-1406-40c9-8515-183325abc72e-merged.mp3",
            "generatedAt": "2007-06-07T20:14:36.355Z",
            "regenerates": [
                {
                    "contents": [
                        82,
                        97,
                        7
                    ],
                    "characters": 58
                },
                {
                    "contents": [
                        7
                    ],
                    "characters": 62
                },
                {
                    "contents": [
                        16,
                        26
                    ],
                    "characters": 84
                }
            ]
        }
    }
}
🟠404Async generation task with specified ID not found
Modified at 2025-08-09 14:26:19
Previous
Get current user's asynchronous generation task list
Next
Delete asynchronous generation task with specified ID