Get the list of voice characters for the current user

This endpoint is not paginated — it returns every voice the user owns in one response, with no limit / offset / cursor. Purchased market voices are prepended to the front of the array and carry ids of the form market:<uuid>; pass them through verbatim when generating.

The statuses lora-pending, lora-failed and lora-awaiting are hidden by default. Pass show=full to see professional clones that are still training or that failed.

An unrecognised version value drops the filter (all versions are returned) rather than raising an error or falling back to some default. from only accepts library / upload; other values are dropped the same way.

INFO

Deprecated alias: /api/tts/voice. See the site document "Versions and migration".

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 voice character list

application/json

Voice list (unpaginated, market voices first)

Bodyapplication/json

Example

{
    "status": 200,
    "message": "OK",
    "data": [
        {
            "id": "ac68e5c9-25d6-4024-b42e-9777c6277b14",
            "idForGenerate": "bf20083c-b161-46eb-8a7e-d9bc62ea7aaf",
            "name": "Sai Guolan",
            "status": "pending",
            "metadata": {
                "avatar": "https://loremflickr.com/3851/3726?lock=5020255648078239",
                "description": "Armchair enthusiast, graduate",
                "prompts": [
                    {
                        "id": "4dd2f015-1c9d-403e-8ef0-23ca76b8ebad",
                        "name": "Brave",
                        "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/744386/002747-playback-lijo9z.mp3"
                    }
                ]
            }
        },
        {
            "id": "ea6c112a-6c78-4d7d-beda-14cecf9fa85b",
            "idForGenerate": "7f6d050c-b227-4cd8-8b2e-03cd53f7fd5c",
            "name": "Che Ziyan",
            "status": "lora-success",
            "metadata": {
                "avatar": "https://loremflickr.com/1215/2227?lock=5797113421436778",
                "description": "Dreamer, inventor, gourmet",
                "prompts": [
                    {
                        "id": "c6955615-18cb-4189-8207-1e7b06a07c10",
                        "name": "Cold",
                        "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/035564/083043-playback-ozp48y.mp3"
                    },
                    {
                        "id": "a5c925ad-ea35-4d89-ae06-c4e538c617e3",
                        "name": "Bitter",
                        "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/538614/851232-playback-u5biu8.mp3"
                    }
                ]
            }
        }
    ]
}

🟠401Unauthorized

🟠429Rate limited

Get the list of voice characters for the current user

Request

Request Code Samples

Responses