Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs（Current）User GuideBack To APP
Api Docs（Current）User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Voice Character
  • Overview
  • Authentication Method
  • Voice Character
    • Create a new voice character
      POST
    • Add a style to the voice character with the specified ID
      POST
    • Upload avatar for the voice character with the specified ID
      POST
    • Add a voice character to the account via a share ID
      POST
    • Get the list of voice characters for the current user
      GET
    • Get details of the voice character with the specified ID
      GET
    • Get the one-time share link ID for the specified voice character ID
      GET
    • Delete Voice Character with the specified ID
      DELETE
    • Delete Style of the specified ID for the Voice Character with the specified ID
      DELETE
  • Voice Generation
    • Synchronous real-time voice generation
      POST
    • Create Asynchronous Voice Generation Task
      POST
    • Get the list of asynchronous generation tasks for the current user
      GET
    • Get the details of an asynchronous generation task by ID
      GET
    • Delete an asynchronous generation task by ID
      DELETE
  • User Account
    • Get current user account information
      GET
  • Content Template
    • Create New Template
      POST
    • Update Template with Specified ID
      POST
    • Get User's Template List
      GET
    • Get Template Details with Specified ID
      GET
    • Delete Template with Specified ID
      DELETE
  1. Voice Character

Upload avatar for the voice character with the specified ID

POST
https://v1.vocu.ai/api/voice/{id}/avatar

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
{
    "avatar": "data:image/png;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgYmFzZVByb2ZpbGU9ImZ1bGwiIHdpZHRoPSIxMzQ2IiBoZWlnaHQ9IjI3ODAiPjxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9IiNjY2E4NjgiLz48dGV4dCB4PSI2NzMiIHk9IjEzOTAiIGZvbnQtc2l6ZT0iMjAiIGFsaWdubWVudC1iYXNlbGluZT0ibWlkZGxlIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmaWxsPSJ3aGl0ZSI+MTM0NngyNzgwPC90ZXh0Pjwvc3ZnPg=="
}

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 --request POST 'https://v1.vocu.ai/api/voice//avatar' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "avatar": "data:image/png;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgYmFzZVByb2ZpbGU9ImZ1bGwiIHdpZHRoPSIxMzQ2IiBoZWlnaHQ9IjI3ODAiPjxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9IiNjY2E4NjgiLz48dGV4dCB4PSI2NzMiIHk9IjEzOTAiIGZvbnQtc2l6ZT0iMjAiIGFsaWdubWVudC1iYXNlbGluZT0ibWlkZGxlIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmaWxsPSJ3aGl0ZSI+MTM0NngyNzgwPC90ZXh0Pjwvc3ZnPg=="
}'

Responses

🟢200Successfully uploaded avatar
application/json
Body

Example
{
    "status": 200,
    "message": "OK",
    "data": {
        "id": "042391f5-5887-403f-a42c-1a67680625bc",
        "idForGenerate": "3c83796b-8cc8-4b8e-a3e2-61761d4d258e",
        "name": "Duan Yuhang",
        "status": "pending",
        "metadata": {
            "avatar": "https://picsum.photos/seed/RsqU7i/371/940",
            "description": "Entrepreneur, inventor, activist",
            "prompts": [
                {
                    "id": "31ef37b0-a4b7-4c87-b6d1-4abfe8725027",
                    "name": "Carefree",
                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/260913/535265-playback-xe595e.mp3"
                }
            ]
        }
    }
}
🟠400Request parameter error
🟠404Voice character with the specified ID not found
🔴500Internal server error
Modified at 2025-11-09 12:11:15
Previous
Add a style to the voice character with the specified ID
Next
Add a voice character to the account via a share ID