Parameter Usage Guide
- When defaultParamFlag is true (Custom Parameters):
- If instrumental is true: style, title, and uploadUrl are required
- If instrumental is false: style, prompt, title, and uploadUrl are required
- Character limits (based on model):
- V4_5, V4_5PLUS & V5 models: prompt max 5000 characters, style max 1000 characters, title max 100 characters
- V3_5 & V4 models: prompt max 3000 characters, style max 200 characters, title max 80 characters
- continueAt: the time point in seconds from which to start extending (must be greater than 0 and less than the uploaded audio duration)
- uploadUrl: specifies the upload location for audio files; ensure uploaded audio does not exceed 8 minutes.
- When defaultParamFlag is false (Default Parameters):
- Regardless of instrumental setting, only uploadUrl and prompt are required
- Other parameters will use the original audio’s parameters
Optional parameters
- vocalGender (string): Preferred vocal gender. Allowed values:
m
(male),f
(female) - styleWeight (number): Style adherence weight in range 0–1 (recommended two decimals)
- weirdnessConstraint (number): Creativity/novelty constraint in range 0–1 (recommended two decimals)
- audioWeight (number): Relative weight of audio consistency in range 0–1 (recommended two decimals)
Developer Notes
- Generated files will be retained for 14 days
- Model version must be consistent with the source music
- This feature is ideal for creating longer works by extending existing music
- Pay attention to character limits for prompt, style, and title to ensure successful processing
- uploadUrl parameter specifies the upload location for audio files; 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
The URL for uploading audio files, required regardless of whether defaultParamFlag is true or false. Ensure the uploaded audio does not exceed 2 minutes in length.
"https://storage.example.com/upload"
Enable custom mode for advanced audio generation settings.
- Set to
true
to use custom parameter mode (requiresstyle
,title
, anduploadUrl
; ifinstrumental
isfalse
,uploadUrl
andprompt
are required). Ifinstrumental
isfalse
, the prompt will be strictly used as lyrics. - Set to
false
to use non-custom mode (onlyuploadUrl
required). Lyrics will be automatically generated based on the prompt.
true
The AI model version to use for generation.
- Required for all requests.
- Available options:
V5
: Superior musical expression, faster generation.V4_5PLUS
: V4.5+ is richer sound, new waysto create, max 8 min.V4_5
: V4.5 is smarter prompts, fastergenerations, max 8 min.V4
: V4 is improved vocal quality,max 4 min.V3_5
: V3.5 is better song structure,max 4 min.
V3_5
, V4
, V4_5
, V4_5PLUS
, V5
"V3_5"
The URL to receive task completion notifications when upload and extend audio 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 Upload and Extend Audio Callbacks
- Alternatively, you can use the Get Music Generation Details interface to poll task status
"https://api.example.com/callback"
Determines whether the audio is instrumental (without lyrics).
- In custom parameter mode (
defaultParamFlag: true
):- If
true
: onlystyle
,title
, anduploadUrl
are required. - If
false
:style
,title
,prompt
(prompt
will be used as exact lyrics), anduploadUrl
are required.
- If
- In non-custom parameter mode (
defaultParamFlag: false
): does not affect required fields (onlyuploadUrl
needed). Iffalse
, lyrics will be automatically generated.
true
Description of how the music should be extended. Required when defaultParamFlag is true. Character limits by model:
- V3_5 & V4: Maximum 3000 characters
- V4_5, V4_5PLUS & V5: Maximum 5000 characters
"Extend the music with more relaxing notes"
Music style, e.g., Jazz, Classical, Electronic. Character limits by model:
- V3_5 & V4: Maximum 200 characters
- V4_5, V4_5PLUS & V5: Maximum 1000 characters
"Classical"
Music title. Character limits by model:
- V3_5 & V4: Maximum 80 characters
- V4_5, V4_5PLUS & V5: Maximum 100 characters
"Peaceful Piano Extended"
The time point (in seconds) from which to start extending the music.
- Required when
defaultParamFlag
istrue
. - Value range: greater than 0 and less than the total duration of the uploaded audio.
- Specifies the position in the original track where the extension should begin.
60
Music styles to exclude from generation
"Relaxing Piano"
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 <= 1
Must be a multiple of 0.01
0.65
Creativity/novelty constraint. Optional. Range: 0-1. Two decimal places recommended.
0 <= x <= 1
Must be a multiple of 0.01
0.65
Relative weight of audio consistency versus other controls. Optional. Range: 0-1. Two decimal places recommended.
0 <= x <= 1
Must be a multiple of 0.01
0.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"