Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)
User GuideBack To APP
Api Docs(Current)
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Styles
  • 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
          GET
        • Add a style to the voice character with the specified ID
          POST
        • Correct the transcription of a style's reference audio
          POST
        • Update a style's name and description
          POST
        • Set a style as the default style
          POST
        • Reset a style and reprocess its reference audio
          POST
        • Delete Style of the specified ID for the Voice Character with the specified ID
          DELETE
    • Voice Generation
      • Async jobs
        • Get the list of asynchronous generation tasks for the current user
        • Get the details of an asynchronous generation task by ID
        • Create Asynchronous Voice Generation Task
        • Upload audio for voice conversion
        • Delete an asynchronous generation task by ID
      • 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. Styles

Update a style's name and description

POST
https://v1.vocu.ai/api/voice/{id}/prompt/{promptId}/info
Modify the specified style's name and description.
Semantics match updating voice-character info and are equally asymmetric: description is overwritten unconditionally (omitting it clears it),
name is written only when truthy.
Both fields go through a content-safety profile check 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}/prompt/{promptId}/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.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Body Params application/json

Example
{
    "name": "string",
    "description": "string"
}

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/voice//prompt//info' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "description": "string"
}'

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
Modified at 2026-08-23 09:24:46
Previous
Correct the transcription of a style's reference audio
Next
Set a style as the default style