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
Enables Custom Mode for advanced audio generation settings.
true to use Custom Mode (requires style and title; prompt required if instrumental is false). The prompt will be strictly used as lyrics if instrumental is false.false for Non-custom Mode (only prompt is required). Lyrics will be auto-generated based on the prompt.true
Determines if the audio should be instrumental (no lyrics).
customMode: true):
true: Only style and title are required.false: style, title, and prompt are required (with prompt used as the exact lyrics).customMode: false): No impact on required fields (prompt only). Lyrics are auto-generated if instrumental is false.true
The model version to use for audio generation.
V5: Superior musical expression, faster generation.V4_5PLUS: V4.5+ is richer sound, new ways to create, max 8 min.V4_5ALL: V4.5-all is better song structure, max 8 min.V4_5: Superior genre blending with smarter prompts and faster output, up to 8 minutes.V4: Best audio quality with refined song structure, up to 4 minutes.V4, V4_5, V4_5PLUS, V4_5ALL, V5 "V4_5ALL"
The URL to receive task completion notifications when music generation is complete.
For detailed callback format and implementation guide, see Music Generation Callbacks
"https://api.example.com/callback"
A description of the desired audio content.
customMode: true): Required if instrumental is false. The prompt will be strictly used as the lyrics and sung in the generated track. Character limits by model:
customMode: false): Always required. The prompt serves as the core idea, and lyrics will be automatically generated based on it (not strictly matching the input). Maximum 500 characters."A calm and relaxing piano track with soft melodies"
The music style or genre for the audio.
customMode: true). Examples: "Jazz", "Classical", "Electronic".
customMode: false): Leave empty."Classical"
The title of the generated music track.
customMode: true). Character limits by model:
customMode: false): Leave empty."Peaceful Piano Meditation"
Only available when Custom Mode (customMode: true) is enabled. Persona ID to apply to the generated music. Optional. Use this to apply a specific persona style to your music generation.
To generate a persona ID, use the Generate Persona endpoint to create a personalized music Persona based on generated music.
"persona_123"
Music styles or traits to exclude from the generated audio.
"Heavy Metal, Upbeat Drums"
Preferred vocal gender for generated vocals. Optional.
m, f "m"
Weight of the provided style guidance. Range 0.00–1.00.
0 <= x <= 1Must be a multiple of 0.010.65
Constraint on creative deviation/novelty. Range 0.00–1.00.
0 <= x <= 1Must be a multiple of 0.010.65
Weight of the input audio influence (where applicable). Range 0.00–1.00.
0 <= x <= 1Must be a multiple of 0.010.65
Request successful
200, 400, 401, 404, 405, 413, 429, 430, 455, 500 200
Error message when code != 200
"success"