POST
/
v2
/
submit

Headers

x-api-key
string

Body

application/json
is_auto
integer
required

is_auto is used to control the use of custom mode or description mode:

  1. is_auto is 1: Description mode, will only use the request parameters prompt and model_version, even if you pass other parameters, such as lyrics, title, etc., we will not apply them.
  2. is_auto is 0: Custom mode, we will apply all parameters to the generation task, including the updated extended song parameters.
Required range: 0 < x < 1
prompt
string
required

The prompt parameter is used to control the melody, tune, style, and so on of the entire song.

Required string length: 1 - 120
lyrics
string
default:

The lyrics parameter controls what the song is about.

title
string
default:

Create a title for the song you're writing.

instrumental
integer
default: 0

The instrumental parameter is used to control whether the song is pure music or not. When instrumental is set to 1, the lyrics parameter will not be applied, even if it is included in your request

Required range: 0 < x < 1
model_version
enum<string>
default:

v3.5 model: The length of the generated song is less than 4 minutes, and the lyrics can be input in length of 3000 characters, which makes the song smoother and more comfortable to listen to. v3.0 model: The length of song generation is less than 2 minutes, and the length of lyrics can be input up to 1000 characters.

Available options:
v3.5,
v3.0
continue_at
integer
default: 0

The continue_at field is used to implement the song extension functionality. This parameter controls the time, in seconds, at which the extended song is enabled. Note that when using the extension function, the continue_at parameter must not be 0 or exceed the song duration, otherwise the request will be considered a failure and used in conjunction with continue_song_id.

continue_song_id
string
default:

The continue_song_id field is used to extend the song. This parameter tells us which song you want to extend, and is used in conjunction with continue_at.

Response

200 - application/json

The response is of type any.