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

Create a new voice character

POST
https://v1.vocu.ai/api/voice

Request

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

Example
{
    "name": "Brandi Grady",
    "prompt": "data:audio/wav;base64,X2WDzbOHAPf88clAqELykihJsChXfWwV1C4Oqx9nFyZp82bzq4EOcrzuCWAIiU9AOovOJRMQRJjkslpXTJuNf5D8wfdrfCRM1JHqktqEDCeFVgZhfl2pVbcRyWDVEybArGf4KCYDIJC9DlpdxZIqXDBOPIznQ5RuyACOKx9HN0zzfVtKeAbW7ujKTiRR3DiHsTrWq7g11bLKznC5Lzjg0cEN0bPDnZdEvs0acuOzRFSQCAoweCyCrkBJv0KM9EjOyRlvsGby7Zqg4odsDqok6NmhN0wpmcoUO7cHjoVitVtnBHtjrf3SpnQ2YhRyEDnWql5i12thBqF6lpZ2j8RjxW4HYBkcdSRkJxZC1QzHdozblKfbkaRJ26Z3Rz2t2mY98pxNUmpHiJD8PWSTJbg3q0YLXu2pFFZ729XN2aGTRA3imzfsjE6vNtN4j8PM7HieHw9yHhX15W4QPJyrTtNVdVj8O3eVYmNlQmwiMNlYfdU2tpZfdxNE",
    "modelVersion": "v3.0",
    "language": "fr",
    "description": "founder",
    "avatar": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgYmFzZVByb2ZpbGU9ImZ1bGwiIHdpZHRoPSIzMzQ4IiBoZWlnaHQ9IjE5NjIiPjxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9IiNjNzJlYzMiLz48dGV4dCB4PSIxNjc0IiB5PSI5ODEiIGZvbnQtc2l6ZT0iMjAiIGFsaWdubWVudC1iYXNlbGluZT0ibWlkZGxlIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmaWxsPSJ3aGl0ZSI+MzM0OHgxOTYyPC90ZXh0Pjwvc3ZnPg==",
    "vocalFilter": false,
    "lora": "71b6711b-9c03-47f4-acfb-bd94dadbaed8"
}

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' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Brandi Grady",
    "prompt": "data:audio/wav;base64,X2WDzbOHAPf88clAqELykihJsChXfWwV1C4Oqx9nFyZp82bzq4EOcrzuCWAIiU9AOovOJRMQRJjkslpXTJuNf5D8wfdrfCRM1JHqktqEDCeFVgZhfl2pVbcRyWDVEybArGf4KCYDIJC9DlpdxZIqXDBOPIznQ5RuyACOKx9HN0zzfVtKeAbW7ujKTiRR3DiHsTrWq7g11bLKznC5Lzjg0cEN0bPDnZdEvs0acuOzRFSQCAoweCyCrkBJv0KM9EjOyRlvsGby7Zqg4odsDqok6NmhN0wpmcoUO7cHjoVitVtnBHtjrf3SpnQ2YhRyEDnWql5i12thBqF6lpZ2j8RjxW4HYBkcdSRkJxZC1QzHdozblKfbkaRJ26Z3Rz2t2mY98pxNUmpHiJD8PWSTJbg3q0YLXu2pFFZ729XN2aGTRA3imzfsjE6vNtN4j8PM7HieHw9yHhX15W4QPJyrTtNVdVj8O3eVYmNlQmwiMNlYfdU2tpZfdxNE",
    "modelVersion": "v3.0",
    "language": "fr",
    "description": "founder",
    "avatar": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgYmFzZVByb2ZpbGU9ImZ1bGwiIHdpZHRoPSIzMzQ4IiBoZWlnaHQ9IjE5NjIiPjxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9IiNjNzJlYzMiLz48dGV4dCB4PSIxNjc0IiB5PSI5ODEiIGZvbnQtc2l6ZT0iMjAiIGFsaWdubWVudC1iYXNlbGluZT0ibWlkZGxlIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmaWxsPSJ3aGl0ZSI+MzM0OHgxOTYyPC90ZXh0Pjwvc3ZnPg==",
    "vocalFilter": false,
    "lora": "71b6711b-9c03-47f4-acfb-bd94dadbaed8"
}'

Responses

🟢200Successfully created voice character
application/json
Body

Example
{
    "status": 200,
    "message": "OK",
    "data": {
        "id": "e4296465-a999-4869-b103-09dc4506bdf1",
        "idForGenerate": "894b9cf3-d0dc-41c9-91dc-2b4947f588d6",
        "name": "Huan Wei",
        "status": "pending",
        "metadata": {
            "avatar": "https://loremflickr.com/1688/727?lock=1030955216131236",
            "description": "A very capable coach",
            "prompts": [
                {
                    "id": "default",
                    "name": "Default Style",
                    "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/062326/734689-playback-kg1wvu.mp3"
                }
            ]
        }
    }
}
🟠400Request parameter error
🟠403No permission to perform this operation
🔴500Internal server error
Modified at 2025-11-09 12:11:15
Previous
Authentication Method
Next
Add a style to the voice character with the specified ID