Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)
User GuideBack To APP
Api Docs(Current)
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Api Docs(Current)
  • 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
        • Add a style to the voice character with the specified ID
        • Correct the transcription of a style's reference audio
        • Update a style's name and description
        • Set a style as the default style
        • Reset a style and reprocess its reference audio
        • Delete Style of the specified ID for the Voice Character with the specified ID
    • 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. Api Docs(Current)

Overview

Welcome to the Vocu API Documentation. We will help you get started with the various development interfaces provided by Vocu.
INFO
This documentation is being gradually improved. Some function interface documents may currently be missing. We are working hard to update this document 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 gain a sufficient understanding of the details and precautions for various Vocu functions.

Prerequisites#

To start using Vocu's API, you need to create a dedicated API Key for yourself in the Vocu API Platform.

What functions can you access via API?#

Currently, you can access almost all Vocu functions via API except for the Store, Check-in, and API Key Management, including multi-sentence asynchronous voice synthesis, single-sentence synchronous voice synthesis, character creation (voice cloning), character management, and voice market character onboarding.

How is the API billed?#

We use the same billing model for the API as when you use the service through the VOCU console, which is to deduct the corresponding points based on the text character count only during generation. Synthesis will not be possible when points are insufficient. Other API functions are free of charge.
Modified at 2025-11-09 12:15:35
Next
Authentication Method