Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)
User GuideBack To APP
Api Docs(Current)
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Async jobs
  • Overview
  • Authentication Method
  • Core
    • Voice Character
      • Manage
        • Get the list of voice characters for the current user
        • Get details of the voice character with the specified ID
        • Create a new voice character
        • Update a voice character's name and description
        • Upload avatar for the voice character with the specified ID
        • Delete Voice Character with the specified ID
      • Styles
        • Get the transcription of a style's reference audio
        • Add a style to the voice character with the specified ID
        • Correct the transcription of a style's reference audio
        • Update a style's name and description
        • Set a style as the default style
        • Reset a style and reprocess its reference audio
        • Delete Style of the specified ID for the Voice Character with the specified ID
    • Voice Generation
      • Async jobs
        • Get the list of asynchronous generation tasks for the current user
          GET
        • Get the details of an asynchronous generation task by ID
          GET
        • Create Asynchronous Voice Generation Task
          POST
        • Upload audio for voice conversion
          POST
        • Delete an asynchronous generation task by ID
          DELETE
      • Synchronous
        • List synthesis parameter presets
        • One-shot synthesis returning an MP3 stream directly
        • Synchronous real-time voice generation
  • Creative
    • Templates
      • Get User's Template List
      • Get Template Details with Specified ID
      • Create New Template
      • Update Template with Specified ID
      • Delete Template with Specified ID
  • Account
    • User
      • Get current user account information
  • Advanced
    • Splitter
      • List splitter configurations
      • Get splitter configuration details
      • Create a splitter configuration
      • Update a splitter configuration (diff mode)
      • Delete a splitter configuration
  • Schemas
    • Generation Template
    • Generation Task
    • Voice Character
    • General Generation Parameters (New)
    • ErrorResponse
  1. Async jobs

Get the list of asynchronous generation tasks for the current user

GET
https://v1.vocu.ai/api/tts/generate
offset / limit pagination, no cursor; detect the last page when fewer items than limit are returned. See the "Pagination" document.
Results are always sorted by createdAt descending, and deleted jobs never appear.
status accepts only pending / processing / generated / failed; any other value silently drops the filter (all statuses are returned) instead of raising an error. projectId behaves the opposite way — a non-UUID value returns 400 VALIDATION_INVALID_FORMAT.
trackId filters by track, and includeUntracked=true additionally includes jobs with no track. Passing stream=1 swaps the audio addresses in the response for pullable stream URLs.
INFO
See the Errors document for the full code reference. Always use the X-Vocu-App-Request-Id response header when troubleshooting.

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 'https://v1.vocu.ai/api/tts/generate?limit=undefined&offset=undefined&status=undefined&stream=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Successfully retrieved the generation task list
application/json
Job list (a plain array with no total; fewer items than limit means this is the last page)
Bodyapplication/json

Example
{
    "status": 200,
    "message": "OK",
    "data": [
        {
            "id": "1e113746-cdaf-4fea-8fbb-107370de94f2",
            "userId": "f92ca16d-cde2-47b2-a8c8-76738672c1a5",
            "status": "generated",
            "type": "vocu-neural-voice-001",
            "metadata": {
                "contents": [
                    {
                        "voiceId": "2a66f799-55d4-4861-8c36-baa594165a70",
                        "text": "18-day aged emu steak, with choice of 2 sides.",
                        "audio": "https://storage.vocu.ai/generate/86a8e903-ebfe-4d2c-bd76-3a261defdb23/b91732a6-020e-4be1-b968-e42276518119-22.mp3",
                        "generatedAt": "1976-06-03T19:52:38.129Z",
                        "preset": "balance",
                        "break_clone": true,
                        "language": "auto",
                        "vivid": false,
                        "emo_switch": [
                            0,
                            0,
                            0,
                            0,
                            0
                        ],
                        "speechRate": 1,
                        "flash": false,
                        "stream": false,
                        "seed": -1
                    },
                    {
                        "voiceId": "1e1c7e38-a975-49d4-ae93-599f3e410cd6",
                        "text": "A robust salty stew featuring Indian Chinese flavors, loaded with golden meat, sweet vegetables, and a delicious, fluffy broth.",
                        "audio": "https://storage.vocu.ai/generate/aa64ea9a-0b76-4b05-90bb-1ee144619427/72ea0c8d-7bb9-48b1-b04d-c17ff65ec0be-23.mp3",
                        "generatedAt": "1947-11-30T11:30:26.143Z",
                        "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": 56,
                "voices": [
                    {
                        "id": "479402b4-b9eb-44c8-a664-44e7b1f46559",
                        "name": "Randall Bradtke",
                        "status": "lora-success",
                        "metadata": {
                            "avatar": "https://loremflickr.com/883/1305?lock=8741851112840771",
                            "description": "nephew supporter  😢",
                            "prompts": [
                                {
                                    "id": "4b83969d-3b1d-485b-8639-963dc8e4cb1c",
                                    "name": "dark",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/301135/325380-playback-4t5wxt.mp3",
                                    "playBackAudio": "https://storage.vocu.ai/prompt/190117/736087-playback-t53ynf.mp3",
                                    "description": "The \"punctual\" emotion style",
                                    "language": "auto",
                                    "vocalFilter": true
                                },
                                {
                                    "id": "a0125312-019f-41b5-82af-8122fd69d112",
                                    "name": "inborn",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/882542/671734-playback-fbxhio.mp3",
                                    "playBackAudio": "https://storage.vocu.ai/prompt/968080/391444-playback-ofjvmj.mp3",
                                    "description": "The \"infamous\" emotion style",
                                    "language": "auto",
                                    "vocalFilter": true
                                },
                                {
                                    "id": "3e3e4eac-2e6c-4f34-80cf-e4d5a84db797",
                                    "name": "cheerful",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/187664/587454-playback-29jotb.mp3",
                                    "playBackAudio": "https://storage.vocu.ai/prompt/546627/488785-playback-95uq42.mp3",
                                    "description": "The \"dazzling\" emotion style",
                                    "language": "auto",
                                    "vocalFilter": true
                                }
                            ]
                        },
                        "version": "v3.0",
                        "from": "upload"
                    },
                    {
                        "id": "b64a19ac-337a-4dec-b2e6-c920f8d0bc6f",
                        "name": "Carlos Cruickshank",
                        "status": "lora-success",
                        "metadata": {
                            "avatar": "https://picsum.photos/seed/Q2Re4v/1578/3907",
                            "description": "lotion fan, writer",
                            "prompts": [
                                {
                                    "id": "d90fdaea-10bb-4d70-9d74-58fb39018326",
                                    "name": "near",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/530970/987181-playback-gq4wgb.mp3",
                                    "playBackAudio": "https://storage.vocu.ai/prompt/418405/595714-playback-8jvnwk.mp3",
                                    "description": "The \"alert\" emotion style",
                                    "language": "auto",
                                    "vocalFilter": true
                                },
                                {
                                    "id": "a8ec7aa5-32c9-4666-9dca-00e4eb3dddb8",
                                    "name": "unused",
                                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/820828/683758-playback-1c6sa6.mp3",
                                    "playBackAudio": "https://storage.vocu.ai/prompt/007481/933061-playback-1zqn70.mp3",
                                    "description": "The \"tedious\" emotion style",
                                    "language": "auto",
                                    "vocalFilter": true
                                }
                            ]
                        },
                        "version": "v2.0",
                        "from": "upload"
                    }
                ],
                "isPremium": false,
                "audio": "https://storage.vocu.ai/generate/a528e70e-db9b-47ec-8ce9-721565c285ea/837f8f26-c453-4ee4-ae04-0aeed30f5918-merged.mp3",
                "generatedAt": "1948-02-11T17:13:20.861Z",
                "srt": false
            }
        }
    ]
}
🟠400Bad request
🟠401Unauthorized
🟠429Rate limited
Modified at 2026-08-23 09:24:46
Previous
Delete Style of the specified ID for the Voice Character with the specified ID
Next
Get the details of an asynchronous generation task by ID