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 current user's asynchronous generation task list

GET
https://v1.vocu.ai/api/tts/generate

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
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?limit&offset&status&stream' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Successfully obtained generation task list
application/json
Body

Example
{
    "status": 200,
    "message": "OK",
    "data": [
        {
            "id": "3221f7df-32b3-421c-a64f-fa25225f28b1",
            "userId": "e96427ca-a8a2-44cc-85f9-85c4f70e86e4",
            "status": "pending",
            "type": "vocu-neural-voice-001",
            "metadata": {
                "contents": [
                    {
                        "voiceId": "175b44ea-beb9-4bbe-85ae-fecbf4d24018",
                        "text": "Our delicious venison, slow-cooked to perfection, accompanied by steamed cos lettuce and a rich, savory gravy.",
                        "audio": "https://storage.vocu.ai/generate/29cb6fbf-1e67-4845-b6e7-f0cc355883b5/361b1e34-5d97-4af9-ab70-9e63e99b5460-12.mp3",
                        "generatedAt": "1975-03-25T12:40:49.994Z"
                    },
                    {
                        "voiceId": "7f5be189-9edb-4ee7-a821-0d683c5587b8",
                        "text": "Three snowpea sprouts with broccoli, kohlrabi, beetroot, leeks and silverbeet. With a side of baked custard apple, and your choice of cauliflower or sultanas.",
                        "audio": "https://storage.vocu.ai/generate/71ac322c-a90a-4e95-8d5b-8818ed52c6e9/60744b48-08d2-4d0d-b208-620751040ca6-13.mp3",
                        "generatedAt": "1948-02-09T12:53:11.787Z"
                    },
                    {
                        "voiceId": "5775de44-4cc3-4884-acc1-db9b80e42fa8",
                        "text": "96-day aged lamb steak, with choice of 3 sides.",
                        "audio": "https://storage.vocu.ai/generate/ad59e9d8-262f-4d3b-a4c9-b24f089e150e/242e533e-9b0c-4f69-b3be-e03583ee8bef-14.mp3",
                        "generatedAt": "1970-01-03T04:01:41.124Z"
                    }
                ],
                "characters": 30,
                "voices": [
                    {
                        "id": "fb05d678-f607-4392-81c5-1f8e8ebc0ae3",
                        "idForGenerate": "1159fbb2-8128-4630-a488-11bac91a95f5",
                        "name": "Jeanette Haley",
                        "status": "pending",
                        "metadata": {
                            "avatar": "https://loremflickr.com/1849/139?lock=3037328888110567",
                            "description": "business owner, leader, photographer 🧅",
                            "prompts": [
                                {
                                    "id": "157e35d1-a060-4f2b-92c2-934228023320",
                                    "name": "delirious",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/858694/425010-playback-z7gdn2.mp3",
                                    "description": "aggravating emotional style"
                                },
                                {
                                    "id": "a4d53819-bdc9-48b7-be72-f7a03a69b80b",
                                    "name": "sparkling",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/851648/964441-playback-jfp43k.mp3",
                                    "description": "golden emotional style"
                                }
                            ]
                        }
                    },
                    {
                        "id": "fbc56ffc-ba8c-4c5e-b46d-a3b0958d109b",
                        "idForGenerate": "16fec3cc-415d-459d-b60c-8793709a38f4",
                        "name": "Randy Treutel",
                        "status": "pending",
                        "metadata": {
                            "avatar": "https://picsum.photos/seed/pVoGrU6N/1491/3630",
                            "description": "geek, nerd, artist 🦍",
                            "prompts": [
                                {
                                    "id": "189e3c4d-80f9-43c2-bcdb-e6403af1af36",
                                    "name": "direct",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/985592/378309-playback-zdt949.mp3",
                                    "description": "outlying emotional style"
                                },
                                {
                                    "id": "f6426cda-0e2a-42a7-a9e6-8236eaae596b",
                                    "name": "nippy",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/238421/015185-playback-tnsy3y.mp3",
                                    "description": "colossal emotional style"
                                }
                            ]
                        }
                    }
                ],
                "temperature": 0.6975925842718108,
                "top_k": 79,
                "top_p": 0.11460809663510763,
                "isPremium": false,
                "audio": "https://storage.vocu.ai/generate/dbd20a57-5f45-493c-9fdd-63718227fc52/9358bd07-27ac-495b-a2eb-190304b180c1-merged.mp3",
                "generatedAt": "1972-09-01T16:36:43.764Z",
                "regenerates": [
                    {
                        "contents": [
                            97,
                            100,
                            64
                        ],
                        "characters": 29
                    },
                    {
                        "contents": [
                            43,
                            86,
                            6
                        ],
                        "characters": 15
                    },
                    {
                        "contents": [
                            32,
                            23
                        ],
                        "characters": 75
                    }
                ]
            }
        },
        {
            "id": "a50968cb-3166-4ceb-8880-040d8da40eb1",
            "userId": "f034ead3-c504-4ee8-815d-09afe8e17ad8",
            "status": "generated",
            "type": "vocu-neural-voice-001",
            "metadata": {
                "contents": [
                    {
                        "voiceId": "f64f323f-edd8-4956-87c4-1da6e4d26ebb",
                        "text": "A classic pie filled with delicious turkey and delicious coriander leaves, baked in a spicy pastry crust and topped with a golden-brown lattice.",
                        "audio": "https://storage.vocu.ai/generate/6c35354d-85fc-48d8-bba5-6b9ee2b00ca6/b1198a5d-d5fc-4246-befe-b59af022fbbd-15.mp3",
                        "generatedAt": "2024-08-13T18:51:38.168Z"
                    },
                    {
                        "voiceId": "3977f18f-6780-4266-ae67-c0b2a8321a11",
                        "text": "Grilled emu kebabs, marinated in Mexican spices and served with a fresh cos lettuce and watermelon salad.",
                        "audio": "https://storage.vocu.ai/generate/7806d154-6623-46e1-8856-bd493c3714c4/12b06d30-00c3-47ad-b5ab-4155fe213963-16.mp3",
                        "generatedAt": "1947-03-04T03:28:24.528Z"
                    },
                    {
                        "voiceId": "e4865658-9332-44ab-ad4d-5c5d0368885c",
                        "text": "An exquisite turkey roast, infused with the essence of honeydew melon, slow-roasted to bring out its natural flavors and served with a side of creamy eggplant",
                        "audio": "https://storage.vocu.ai/generate/b5c2f02c-a733-457a-8acc-5e044e67bd92/9bf6cf61-0a52-44ee-807f-2b6fe0f71693-17.mp3",
                        "generatedAt": "2024-03-15T06:02:22.860Z"
                    }
                ],
                "characters": 40,
                "voices": [
                    {
                        "id": "ca3b2f05-21b1-4d74-892e-7875c96cfb13",
                        "idForGenerate": "a394225b-2352-4a17-a61d-2f2b00959c92",
                        "name": "Rodney Bosco",
                        "status": "lora-success",
                        "metadata": {
                            "avatar": "https://loremflickr.com/198/713?lock=6555337202775397",
                            "description": "minion junkie, blogger 🦭",
                            "prompts": [
                                {
                                    "id": "af22d03d-5469-41e5-a457-4894d4492894",
                                    "name": "well-made",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/614780/349505-playback-dszmwe.mp3",
                                    "description": "dependable emotional style"
                                }
                            ]
                        }
                    },
                    {
                        "id": "e18c66d0-4142-40a6-8123-f20b0fc07865",
                        "idForGenerate": "3c584c2a-ced3-40c6-9368-f575682b3115",
                        "name": "Alexis Ernser-Gibson",
                        "status": "pending",
                        "metadata": {
                            "avatar": "https://loremflickr.com/2424/2655?lock=6840852879870500",
                            "description": "business owner, traveler, philosopher",
                            "prompts": [
                                {
                                    "id": "7f671767-607c-4932-991d-2d31d86adfba",
                                    "name": "heartfelt",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/581466/493878-playback-2buj2f.mp3",
                                    "description": "acclaimed emotional style"
                                },
                                {
                                    "id": "51a5419f-5210-4ea1-89df-c4251bd64fdd",
                                    "name": "wry",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/961470/567886-playback-pyoy6p.mp3",
                                    "description": "good emotional style"
                                }
                            ]
                        }
                    },
                    {
                        "id": "9259d48b-ccff-4296-8911-a2d0fbded8c7",
                        "idForGenerate": "8133975b-982f-4abb-a12c-38a7eb39421f",
                        "name": "Leslie Rath",
                        "status": "pending",
                        "metadata": {
                            "avatar": "https://loremflickr.com/1932/835?lock=3036723661297933",
                            "description": "humor advocate, film lover",
                            "prompts": [
                                {
                                    "id": "80dfce52-3b67-4f5d-bad1-c1b1b53bbcb2",
                                    "name": "confused",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/344901/284042-playback-071mxz.mp3",
                                    "description": "immediate emotional style"
                                }
                            ]
                        }
                    }
                ],
                "temperature": 0.6693336054994602,
                "top_k": 82,
                "top_p": 0.4531556437571812,
                "isPremium": false,
                "audio": "https://storage.vocu.ai/generate/54b1a80d-a5ed-4fd0-aeba-07a1757f19b2/a5e25797-3234-4430-b16a-37c4d750da0f-merged.mp3",
                "generatedAt": "1954-04-22T14:27:49.006Z",
                "regenerates": [
                    {
                        "contents": [
                            52,
                            67
                        ],
                        "characters": 37
                    },
                    {
                        "contents": [
                            22,
                            93
                        ],
                        "characters": 4
                    },
                    {
                        "contents": [
                            91,
                            74,
                            7
                        ],
                        "characters": 57
                    }
                ]
            }
        }
    ]
}
Modified at 2025-08-09 14:25:53
Previous
Simple streaming voice generation
Next
Get asynchronous generation task details for specified ID