Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)User GuideBack To APP
Api Docs(Current)User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Api Docs(Current)
  • Overview
  • Authentication method
  • Low latency WebSocket real-time generation
  • Voice character
    • Create new voice character
      POST
    • Add style to voice character with specified ID
      POST
    • Upload avatar for voice character with specified ID
      POST
    • Add voice character to account via share ID
      POST
    • Get current user's voice character list
      GET
    • Get voice character details for specified ID
      GET
    • Get one-time share link ID for specified voice character ID
      GET
    • Delete voice character with specified ID
      DELETE
    • Delete specified ID style of voice character with specified ID
      DELETE
  • Voice generation
    • Synchronous real-time voice generation
      POST
    • Create asynchronous voice generation task
      POST
    • Regenerate asynchronous generation task for specified ID
      POST
    • Simple streaming voice generation
      GET
    • Get current user's asynchronous generation task list
      GET
    • Get asynchronous generation task details for specified ID
      GET
    • Delete asynchronous generation task with specified ID
      DELETE
  • User account
    • Get current user account information
      GET
  • File management
    • Create chunked upload file for subsequent professional cloning use
      POST
    • Upload chunk file
      POST
    • Complete file chunked upload
      POST
    • Simple file upload
      POST
  • Content template
    • Create new template
      POST
    • Update template with specified ID
      POST
    • Get user's template list
      GET
    • Get template details for specified ID
      GET
    • Delete template with specified ID
      DELETE
  1. Api Docs(Current)

Overview

Welcome to the Vocu API documentation, we will help you get started with various development interfaces provided by Vocu
INFO
This documentation is being gradually improved. Some interface documentation for certain features may currently be missing. We are working hard to update this documentation to improve your development experience as much as possible
WARNING
Before developing with the API, we strongly recommend that you read the Vocu User Guide completely to help you have sufficient understanding of the details and precautions of various Vocu functions

Prerequisites#

To start using Vocu's API, you need to complete at least one payment of any amount in your account and create your exclusive API Key in the Vocu Developer Center。

What features can you access through the API?#

Currently, you can access almost all Vocu features through the API except for store, check-in, and API Key management, including multi-sentence voice async synthesis, single-sentence voice sync synthesis, character creation (voice cloning), character management, voice market character warehousing, etc.。

How is the API billed?#

For the API, we adopt the same billing model as when you use the service through the VOCU console, that is, points are deducted based on the number of text characters only during generation. When points are insufficient, synthesis cannot be performed. Other API functions are free of charge。
Modified at 2025-08-09 14:44:48
Next
Authentication method