This endpoint layers AI-generated vocals on top of an existing instrumental. Given a prompt (e.g., lyrical concept or musical mood) and optional audio, it produces vocal output harmonized with the provided track.
🔑 API Authentication
All endpoints require authentication using Bearer Token.
Add to request headers:
Authorization: Bearer YOUR_API_KEY⚠️ Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately from the management page
Description of the audio content to generate vocals for. Required. Provides context about the desired vocal style and content. The more detailed your prompt, the better the vocal generation will match your vision.
"A calm and relaxing piano track with soothing vocals"
The title of the music track. Required. This will be used as the title for the generated vocal track.
"Relaxing Piano with Vocals"
Music styles or vocal traits to exclude from the generated track. Required. Use to avoid specific vocal styles or characteristics.
"Heavy Metal, Aggressive Vocals"
The music and vocal style. Required. Examples: Jazz, Classical, Electronic, Pop. Describes the overall genre and vocal approach.
"Jazz"
The URL of the uploaded audio file to add vocals to. Required. Must be a valid audio file URL accessible by the system. The uploaded audio should be in a supported format (MP3, WAV, etc.).
"https://example.com/instrumental.mp3"
The URL to receive task completion notifications when vocal generation is complete. The callback process has three stages: text (text generation), first (first track complete), complete (all tracks complete). Note: In some cases, text and first stages may be skipped, directly returning complete. For detailed callback format and implementation guide, see Add Vocals Callbacks. Alternatively, you can use the Get Music Generation Details interface to poll task status.
"https://api.example.com/callback"
Preferred vocal gender. Optional. Allowed values: 'm' (male), 'f' (female).
m, f "m"
Style adherence weight. Optional. Range: 0-1. Two decimal places recommended.
0 <= x <= 1Must be a multiple of 0.010.61
Creativity/novelty constraint. Optional. Range: 0-1. Two decimal places recommended.
0 <= x <= 1Must be a multiple of 0.010.72
Relative weight of audio consistency versus other controls. Optional. Range: 0-1. Two decimal places recommended.
0 <= x <= 1Must be a multiple of 0.010.65
Request successful
Status code. 200 - Request successful, 400 - Invalid parameters, 401 - Unauthorized access, 404 - Invalid request method or path, 405 - Rate limit exceeded, 413 - Theme or prompt too long, 429 - Insufficient credits, 430 - Your call frequency is too high. Please try again later, 455 - System maintenance, 500 - Server error
200, 400, 401, 404, 405, 413, 429, 430, 455, 500 200
Error message when code != 200
"success"