Sign in

v1

latestOpenAPI 3.1.02026-07-26273351.7 KB
AI-Music-Generator

V2 Generate Music

Music generation task submission endpoints:

  1. Make a request with the required parameters (parameters are described in detail in the schema below).
  2. the endpoint will return the song information, including the song id and audio audition and image routing and task processing status (stream, error, complete).
  3. Song id can query song information and generation status through the query interface.
  4. In particular, do not use the V2 interface for arguments or responses in V1, it is just not allowed
post/v2/submit

Headers

x-api-keystring

Request body

is_autointeger 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.
model_version'v4.5-plus' | 'v4.5' | 'v4.0' | 'v3.5' | 'v3.0' required

v4.5-plus: Generates songs up to 8 minutes long and supports lyrics inputs of up to 5,000 words. Leveraging the latest and most powerful music generation models, it delivers richer sound quality and faster generation speeds. v4.5: Generates songs up to 8 minutes long and supports lyrics inputs of up to 5,000 words. It boasts studio-quality sound, optimal genre fusion, and faster generation speeds. v4.0: Generates songs up to 4 minutes long and supports lyrics inputs of up to 3,000 words. Songs are more vivid and sound better. v3.5: Generates songs up to 4 minutes long and supports lyrics inputs of up to 3,000 words. Songs are smoother and more engaging. v3.0: Generates songs up to 2 minutes long and supports lyrics inputs of up to 1,000 words.

promptstring required

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

lyricsstring nullable

The lyrics parameter controls what the song is about.

titlestring nullable

Create a title for the song you're writing.

instrumentalinteger nullable

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

continue_atinteger nullable

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_idstring nullable

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.

Example request

{
  "is_auto": 1,
  "model_version": "v3.5",
  "prompt": "Happy songs",
  "lyrics": "Enter the lyrics you've created",
  "title": "AI Music"
}

Response

Successful Response

{"stackTrail":"paths:/v2/submit:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}