Update a voice character's name and description

Modify the voice character's name and metadata.description.

Note the asymmetric semantics: description is written unconditionally (passing undefined clears the description), while name is updated only when truthy —
passing an empty string is equivalent to not renaming.

Both fields first go through content-safety profile checks together; failure returns SAFETY_PROFILE_REJECTED (response body includes traceId).

You can only operate voices you created, and the voice must not be in creating / failed. See the "Create a voice character" document.

INFO

Deprecated alias: /api/tts/voice/{id}/info. 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 ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Updated. Returns the full voice character object after the update.

Bodyapplication/json

Example

{
    "status": 200,
    "data": {
        "id": "7c3d9a12-5e84-4b06-9f21-8ad3e6b40c57",
        "name": "Gentle female voice",
        "status": "pending",
        "from": "upload",
        "version": "v3.0",
        "originId": null,
        "userId": "2f81b40c-9d63-4e17-a5b8-31c7d0e926af",
        "avatar": "https://storage.vocu.ai/avatar/voice/2f81b40c-9d63-4e17-a5b8-31c7d0e926af/7c3d9a12-5e84-4b06-9f21-8ad3e6b40c57.png",
        "createdAt": "2026-07-14T06:22:08.000Z",
        "updatedAt": "2026-08-19T11:04:37.000Z",
        "deletedAt": null,
        "metadata": {
            "description": "A gentle female voice for everyday narration",
            "avatar": "https://storage.vocu.ai/avatar/voice/2f81b40c-9d63-4e17-a5b8-31c7d0e926af/7c3d9a12-5e84-4b06-9f21-8ad3e6b40c57.png",
            "prompts": [
                {
                    "id": "default",
                    "name": "Default",
                    "description": "Calm narration",
                    "enhance": true,
                    "language": "zh",
                    "flags": [
                        "20250227-vcb",
                        "v3:20250828-vfa"
                    ],
                    "playBackAudio": "https://storage.vocu.ai/prompt/2f81b40c-9d63-4e17-a5b8-31c7d0e926af/default-playback.mp3",
                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/2f81b40c-9d63-4e17-a5b8-31c7d0e926af/default-origin.wav",
                    "baseSpeechRate": 4.6
                }
            ]
        }
    }
}

🟠400Bad request

🟠401Unauthorized

🟠403Forbidden

🟠404Not found

🟠409Conflict

🟠429Rate limited

🔴500Server error