- Overview
- Authentication method
- Low latency WebSocket real-time generation
- Voice character
- Create new voice characterPOST
- Add style to voice character with specified IDPOST
- Upload avatar for voice character with specified IDPOST
- Add voice character to account via share IDPOST
- Get current user's voice character listGET
- Get voice character details for specified IDGET
- Get one-time share link ID for specified voice character IDGET
- Delete voice character with specified IDDELETE
- Delete specified ID style of voice character with specified IDDELETE
- Create new voice character
- Voice generation
- Synchronous real-time voice generationPOST
- Create asynchronous voice generation taskPOST
- Regenerate asynchronous generation task for specified IDPOST
- Simple streaming voice generationGET
- Get current user's asynchronous generation task listGET
- Get asynchronous generation task details for specified IDGET
- Delete asynchronous generation task with specified IDDELETE
- Synchronous real-time voice generation
- User account
- File management
- Content template
Upload avatar for voice character with specified ID
POST
https://v1.vocu.ai/api/tts/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/tts/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 specified ID not found
🔴500Internal Server Error
Modified at 2025-08-09 14:14:53