Vocu Developers
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
Api Docs(Current)
User GuideBack To APP
Api Docs(Current)
User GuideBack To APP
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
🇺🇸 English
  • 🇺🇸 English
  • 🇨🇳 简体中文
  1. Splitter
  • 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
      • Get splitter configuration details
        GET
      • Create a splitter configuration
        POST
      • Update a splitter configuration (diff mode)
        POST
      • Delete a splitter configuration
        DELETE
  • Schemas
    • Generation Template
    • Generation Task
    • Voice Character
    • General Generation Parameters (New)
    • ErrorResponse
  1. Splitter

Update a splitter configuration (diff mode)

POST
https://v1.vocu.ai/api/splitter/{id}
Update a splitter configuration. At least one of name and config must be provided, otherwise VALIDATION_MISSING_FIELD.
config is deep-merged in diff mode, not wholesale replaced
Only keys that are passed are updated; omitted keys stay as they were.
When both sides are non-array objects, merge recursively; otherwise overwrite (arrays are overwritten as a whole).
Explicitly setting a key's value to null deletes that key.
After the merge, the merged result is re-run through the same validation as create; failure rolls the whole update back as TTS_SPLITTER_INVALID.
That means a seemingly local deletion (for example deleting the last placeholder with no fallbackConfig) can also make the entire configuration invalid and be rejected.
Note: this endpoint uses POST, not PUT/PATCH.
INFO
See the Errors document for the full code reference. Always use the X-Vocu-App-Request-Id response header when troubleshooting.

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
{
    "name": "string",
    "config": {
        "splitterMarks": [
            "st"
        ],
        "lookupTable": {
            "property1": "string",
            "property2": "string"
        },
        "fallbackConfig": {
            "voiceId": "string"
        },
        "property1": "string",
        "property2": "string"
    }
}

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 'https://v1.vocu.ai/api/splitter/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "config": {
        "splitterMarks": [
            "st"
        ],
        "lookupTable": {
            "property1": "string",
            "property2": "string"
        },
        "fallbackConfig": {
            "voiceId": "string"
        },
        "property1": "string",
        "property2": "string"
    }
}'

Responses

🟢200Success
application/json
Updated. Returns the full configuration after the merge.
Bodyapplication/json

Example
{
    "status": 200,
    "data": {
        "id": "3f2a1b6c-8d4e-4f27-9a10-5c7e2d81b043",
        "name": "Three-speaker dialogue configuration",
        "config": {
            "<CharacterA>": {
                "voiceId": "9d7f2e14-5b30-4a6c-8e91-c2340af6b7d5",
                "speechRate": 1.2
            },
            "<CharacterC>": {
                "voiceId": "5e6a90b3-1c47-4d82-a0f5-38b7ce2419d6",
                "speechRate": 1
            },
            "[faster_speech:1.2]": {
                "speechRate": 1.2
            }
        },
        "createdAt": "2026-08-12T09:31:44.000Z",
        "updatedAt": "2026-08-19T14:22:03.000Z"
    }
}
🟠400Bad request
🟠401Unauthorized
🟠404Not found
🟠429Rate limited
🔴500Server error
Modified at 2026-08-23 09:24:46
Previous
Create a splitter configuration
Next
Delete a splitter configuration