Parameter Usage Guide
- When customMode is true (Custom Mode):
- If instrumental is true: style, title and uploadUrl are required
- If instrumental is false: style, prompt, title and uploadUrl are required
- prompt length limit by model:
- V3_5 & V4: Maximum 3000 characters
- V4_5 & V4_5PLUS: Maximum 5000 characters
- style length limit by model:
- V3_5 & V4: Maximum 200 characters
- V4_5 & V4_5PLUS: Maximum 1000 characters
- title length limit by model:
- V3_5 & V4: Maximum 80 characters
- V4_5 & V4_5PLUS: Maximum 100 characters
- uploadUrl is used to specify the upload location of the audio file; ensure the uploaded audio does not exceed 8 minutes in length.
- When customMode is false (Non-custom Mode):
- Only prompt and uploadUrl are required regardless of instrumental setting
- prompt length limit: 400 characters
- Other parameters should be left empty
Developer Notes
- Recommended settings for new users: Set customMode to false, instrumental to false, and only provide prompt and uploadUrl. This is the simplest configuration to quickly test the API and experience the results.
- Generated files will be deleted after 15 days
- Ensure all required parameters are provided based on customMode and instrumental settings to avoid errors
- Pay attention to character limits for prompt, style, and title to ensure successful processing
- Callback process has three stages: text (text generation complete), 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
- The uploadUrl parameter is used to specify the upload location of the audio file; please provide a valid URL.
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
application/json
Response
Request successful
The response is of type object
.