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）

Authentication Method

Learn how to use your API Key for authentication and to use our services

Get Your API Key #

You need to use an API Key to verify your identity when using Vocu's developer interfaces. You can access the API Platform from the side menu bar, and click the Create API Key button. In the pop-up window, give any name to this API Key (to facilitate recording its purpose). After confirmation, you will get a new API Key.
INFO
Each account can have a maximum of 5 different API Keys simultaneously. Once the limit is reached, you can create a new one by deleting any existing API Key. Deleted API Keys will become completely invalid and can no longer be used to access any Vocu API services.
WARNING
For security reasons, each API Key will only be displayed in plaintext in the pop-up window upon initial creation. Please keep it safe; you will not be able to retrieve it after closing the pop-up window.

Access Authentication#

After obtaining the API Key, you can easily complete authentication by including the following entry in the Header of any API request.
Authorization: Bearer <Your API Key>
For example:
Authorization: Bearer sk-2cdeh2375692vq5hp9fp32f58p967tca
Modified at 2025-11-09 12:16:11
Previous
Overview
Next
Get the list of voice characters for the current user