- Stream URL: Available in 30-40 seconds.
- Downloadable song URL: Ready in 2-3 minutes.
Parameter Usage Guide
- When customMode is true (Custom Mode):
- If instrumental is true: style and title are required
- If instrumental is false: style, prompt, and title are required
- Prompt length limit:
- For V3_5 and V4 models: 3000 characters
- For V4_5, V4_5PLUS and V5 models: 5000 characters
- Style length limit:
- For V3_5 and V4 models: 200 characters
- For V4_5, V4_5PLUS and V5 models: 1000 characters
- title length limit: 80 characters
- When customMode is false (Non-custom Mode):
- Only prompt is required regardless of instrumental setting
- prompt length limit: 500 characters
- Other parameters should be left empty
Developer Notes
- Recommendation for First-Time Users: Start with customMode: false and instrumental: false, and only provide a prompt. This is the simplest setup to quickly test the API and experience the results.
- Generated files are retained for 15 days before being deleted
- Ensure all required fields are provided based on the customMode and instrumental settings to avoid errors
- Respect the character limits for prompt, style, and title to ensure successful processing
- Callback process has three stages: text (text generation), first (first track complete), complete (all tracks complete)
- You can use the Get Music Generation Details endpoint to actively check task status instead of waiting for callbacks
Authorizations
🔑 API Authentication
All endpoints require authentication using Bearer Token.
Get API Key
- Visit the API Key Management Page to obtain your API Key
Usage
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
Body
Enables Custom Mode for advanced audio generation settings.
- Set to
trueto use Custom Mode (requiresstyleandtitle;promptrequired ifinstrumentalisfalse). The prompt will be strictly used as lyrics ifinstrumentalisfalse. - Set to
falsefor Non-custom Mode (onlypromptis required). Lyrics will be auto-generated based on the prompt.
true
Determines if the audio should be instrumental (no lyrics).
- In Custom Mode (
customMode: true):- If
true: Onlystyleandtitleare required. - If
false:style,title, andpromptare required (withpromptused as the exact lyrics).
- If
- In Non-custom Mode (
customMode: false): No impact on required fields (promptonly). Lyrics are auto-generated ifinstrumentalisfalse.
true
The model version to use for audio generation.
- Available options:
V5: Superior musical expression, faster generation.V4_5PLUS: V4.5+ is richer sound, new ways to create, 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.V3_5: Solid arrangements with creative diversity, up to 4 minutes.
V3_5, V4, V4_5, V4_5PLUS, V5 "V3_5"
The URL to receive task completion notifications when music generation is complete.
For detailed callback format and implementation guide, see Music Generation Callbacks
- Alternatively, you can use the get music generation details endpoint to poll task status
"https://api.example.com/callback"
A description of the desired audio content.
- In Custom Mode (
customMode: true): Required ifinstrumentalisfalse. The prompt will be strictly used as the lyrics and sung in the generated track. Character limits by model:- V3_5 & V4: Maximum 3000 characters
- V4_5, V4_5PLUS & V5: Maximum 5000 characters
Example: "A calm and relaxing piano track with soft melodies"
- In Non-custom Mode (
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.
Example: "A short relaxing piano tune"
"A calm and relaxing piano track with soft melodies"
The music style or genre for the audio.
- Required in Custom Mode (
customMode: true). Examples: "Jazz", "Classical", "Electronic".- For V3_5 and V4 models: Max length: 200 characters.
- For V4_5, V4_5PLUS and V5 models: Max length: 1000 characters.
Example: "Classical"
- In Non-custom Mode (
customMode: false): Leave empty.
"Classical"
The title of the generated music track.
- Required in Custom Mode (
customMode: true). Max length: 80 characters.
Example: "Peaceful Piano Meditation" - In Non-custom Mode (
customMode: false): Leave empty.
"Peaceful Piano Meditation"
Music styles or traits to exclude from the generated audio.
- Optional. Use to avoid specific styles.
Example: "Heavy Metal, Upbeat Drums"
"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
Response
Request successful
Status Codes
- ✅ 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"
