Create asynchronous voice generation task

POST

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 ********************

Body Params application/json

Example

{
    "contents": [
        {
            "voiceId": "d1969f83-1891-4da0-8232-1014382428d1",
            "text": "Hello everyone, the weather is really nice today, what do you think?",
            "promptId": "8c4a7d21"
        },
        {
            "voiceId": "6c69eac1-34aa-43ad-89f1-6ba1b9f5e004",
            "text": "What a coincidence, I also think it's very nice, we think alike",
            "promptId": "e7263005"
        }
    ],
    "preset": "v2_creative",
    "randomness": 100,
    "stability_boost": 1024,
    "probability_optimization": 100,
    "break_clone": true,
    "sharpen": true,
    "flash": false,
    "stream": true,
    "srt": true,
    "seed": null,
    "dictionary": []
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://v1.vocu.ai/api/tts/generate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contents": [
        {
            "voiceId": "d1969f83-1891-4da0-8232-1014382428d1",
            "text": "Hello everyone, the weather is really nice today, what do you think?",
            "promptId": "8c4a7d21"
        },
        {
            "voiceId": "6c69eac1-34aa-43ad-89f1-6ba1b9f5e004",
            "text": "What a coincidence, I also think it'\''s very nice, we think alike",
            "promptId": "e7263005"
        }
    ],
    "preset": "v2_creative",
    "randomness": 100,
    "stability_boost": 1024,
    "probability_optimization": 100,
    "break_clone": true,
    "sharpen": true,
    "flash": false,
    "stream": true,
    "srt": true,
    "seed": null,
    "dictionary": []
}'

Responses

🟢200Successfully created asynchronous generation task

application/json

Body

Example

{
    "status": 200,
    "message": "OK",
    "data": {
        "id": "ec138706-823b-420f-a78b-9c5cf2053997",
        "userId": "0bc323ca-7be4-4526-af56-3f9f3052a838",
        "status": "failed",
        "type": "vocu-neural-voice-001",
        "metadata": {
            "contents": [
                {
                    "voiceId": "9946da5f-8212-48c3-8041-f56a4bb0d853",
                    "text": "Crispy fried snake meat chunks, seasoned with Sichuan peppercorns, served with blackberry sauce for dipping.",
                    "audio": "https://storage.vocu.ai/generate/7cdaabdf-b066-46c1-a05a-0f28f82a33ae/a3be0533-dec7-4a96-8c52-f46ce48b96aa-13.mp3",
                    "generatedAt": "2022-12-14T11:35:53.880Z"
                },
                {
                    "voiceId": "42dcfc75-0d56-45eb-9cd4-4003b0515354",
                    "text": "A delightful fruit tart that combines soft sun-dried tomatoes and sweet plums, nestled in a buttery pastry shell, finished with a hint of licorice.",
                    "audio": "https://storage.vocu.ai/generate/1c96d289-fd72-441b-8979-575522fb8e56/71d9f624-ea36-4f9b-8fcf-bf850a7e1807-14.mp3",
                    "generatedAt": "1964-02-04T21:19:38.944Z"
                },
                {
                    "voiceId": "71741003-7260-417b-ad90-65d7ebaebe18",
                    "text": "A simple papaya pie. No fancy stuff, just pie.",
                    "audio": "https://storage.vocu.ai/generate/300a4ed1-d313-4079-a827-13067b66fc00/35c366d9-2bf3-4fe0-9984-d25d1d55e116-15.mp3",
                    "generatedAt": "1948-07-29T22:04:22.900Z"
                }
            ],
            "characters": 97,
            "voices": [
                {
                    "id": "4798e410-1774-4f02-a461-efa48e430f75",
                    "idForGenerate": "c5c650a2-0657-4c56-94a7-5b56ddf02232",
                    "name": "Chai Xiyao",
                    "status": "lora-failed",
                    "metadata": {
                        "avatar": "https://picsum.photos/seed/adLqxCP8/623/417",
                        "description": "Parent, geek, foodie",
                        "prompts": [
                            {
                                "id": "4f22aac1-1e86-4d19-b419-e7dd8b175dd0",
                                "name": "Reckless",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/570095/643676-playback-4bk7te.mp3",
                                "description": "Reckles Emotion Style"
                            },
                            {
                                "id": "5b7036ad-6faa-451e-9258-aef2db25f454",
                                "name": "Upright",
                                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/845026/577993-playback-hexto7.mp3",
                                "description": "Upright Emotion Style"
                            }
                        ]
                    }
                }
            ],
            "temperature": 1,
            "top_k": 1024,
            "top_p": 1,
            "isPremium": false,
            "audio": "https://storage.vocu.ai/generate/2f09e6c1-d560-483a-ade8-7b6923de4d47/851c7cf9-db66-41a7-9f26-5f27f46c7788-merged.mp3",
            "generatedAt": "1971-07-21T05:54:29.797Z",
            "regenerates": [
                {
                    "contents": [
                        1
                    ],
                    "characters": 82
                },
                {
                    "contents": [
                        1,
                        2
                    ],
                    "characters": 29
                }
            ]
        }
    }
}

🟠400Request parameter error

🟠403Insufficient credits

Modified at 2025-08-09 14:19:33

Synchronous real-time voice generation

Regenerate asynchronous generation task for specified ID