Skip to main content
POST
The model name of Flow Music in AIReiter is flow_music. For lyrics, continuation, replacement, cover, stem separation, upload, download, and MV generation, please use the corresponding model.

Authorizations

string
required
All endpoints require Bearer Token authentication.Get the API Key:Visit the API Key Management page to get your API Key.Add the following to the request header:

Body

string
required
Model name, use the following fixed value:
  • flow_music
object
required
Model parameters object.
string
required
Client task ID.User-defined task identifier, required. Only letters, numbers, underscores, and hyphens are supported, length 1-64 characters. You can use this ID later to query task status and results.

Response

string
The initiator’s task ID, which can be used to query the result.
string
Initial status, usually "pending".
string
Creation time, in ISO format.

Query Task

Flow Music is an asynchronous music generation model. After submitting the task, use out_task_id to query the task status. Once completed, output usually contains 1 item, with fields audio (audio URL), url (cover image), title, text (lyric excerpt), and clip_id.
string
required
The initiator task ID passed when submitting the task.
After the query succeeds and the task is completed, output example:

Request Examples

Mode Notes

The clip_id from a successful result is used for flow_music_extend / flow_music_replace / flow_music_cover / flow_music_stems / flow_music_download / flow_music_video. length is not a hard limit.