Get the details of an asynchronous generation task by ID

Polls a job created by POST /api/tts/generate. The terminal values of status are generated (success) and failed; pending (waiting) and processing (synthesising) are intermediate. The audio URL is only usable once the status is generated.

Pace your polling yourself. May return RATE_LIMIT_* (HTTP 429). Read Retry-After and retry with exponential backoff. See the "Errors" document.

Passing stream=1 swaps the audio address for a play-while-downloading stream URL (with an auth query parameter), which is useful for starting playback as soon as the job enters processing.

You can only read your own jobs; someone else's job and a deleted job both return GENERATE_NOT_FOUND (404), with no distinction between "missing" and "forbidden".

INFO

See the Errors document for the full code reference. Always use the X-Vocu-App-Request-Id response header when troubleshooting.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Successfully retrieved asynchronous generation task details

application/json

Job details; the audio URL is only valid once status === "generated"

Bodyapplication/json

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": "The \"eminent\" emotion style",
                                "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": "The \"ill-fated\" emotion style",
                                "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
        }
    }
}

🟠401Unauthorized

🟠404Not found

🟠429Rate limited

Get the details of an asynchronous generation task by ID

Request

Request Code Samples

Responses