Seedance 2.0 by ByteDance is now live on fal! 🚀
Docs
Log-inSign-up

fal-ai/minimax-music/v2.5

MiniMax Music 2.5 creates complete tracks with singing, backing music, and detailed arrangements from lyrics and a style description.
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPIExamples

Table of contents

About

Text To Music V2 5

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/minimax-music/v2.5", {
  input: {
    prompt: "Indie folk, melancholic, introspective, longing, solitary walk, coffee shop"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/minimax-music/v2.5", {
  input: {
    prompt: "Indie folk, melancholic, introspective, longing, solitary walk, coffee shop"
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/minimax-music/v2.5", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/minimax-music/v2.5", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

A description of the music style, mood, genre, and scenario. Max 2000 characters.

lyrics string

Lyrics of the song. Use to separate lines. Supports structure tags: [Intro], [Verse], [Pre Chorus], [Chorus], [Bridge], [Outro], [Interlude], [Hook], [Break], [Solo], [Inst]. Max 3500 characters. Required when is_instrumental is false and lyrics_optimizer is false. Default value: ""

is_instrumental boolean

When true, generates vocal-free instrumental music.

lyrics_optimizer boolean

When true and lyrics is empty, auto-generates lyrics from the prompt.

audio_setting AudioSetting25

Audio configuration settings

{
  "prompt": "Indie folk, melancholic, introspective, longing, solitary walk, coffee shop",
  "lyrics": "[verse]\nStreetlights flicker, the night breeze sighs\nShadows stretch as I walk alone\n[chorus]\nWandering, longing, where should I go"
}

Output#

audio File* required

The generated music

{
  "audio": {
    "url": "https://v3b.fal.media/files/b/kangaroo/GJe3sQehFteUTmpDROzOs_output.mp3"
  }
}

Other types#

AudioSetting25#

sample_rate SampleRateEnum

Sample rate of generated audio Default value: "44100"

Possible enum values: 16000, 24000, 32000, 44100

bitrate BitrateEnum

Bitrate of generated audio Default value: "256000"

Possible enum values: 32000, 64000, 128000, 256000

format FormatEnum

Audio format Default value: "mp3"

Possible enum values: mp3, wav, pcm

TextToMusic15Request#

prompt string* required

Lyrics, supports [intro][verse][chorus][bridge][outro] sections. 10-600 characters.

audio_setting AudioSetting

Audio configuration settings

lyrics_prompt string* required

Control music generation. 10-3000 characters.

AudioSetting#

sample_rate SampleRateEnum

Sample rate of generated audio Default value: "44100"

Possible enum values: 8000, 16000, 22050, 24000, 32000, 44100

bitrate BitrateEnum

Bitrate of generated audio Default value: "256000"

Possible enum values: 32000, 64000, 128000, 256000

format FormatEnum

Audio format Default value: "mp3"

Possible enum values: mp3, pcm, flac

File#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

TextToMusicRequest#

prompt string* required

Lyrics with optional formatting. You can use a newline to separate each line of lyrics. You can use two newlines to add a pause between lines. You can use double hash marks (##) at the beginning and end of the lyrics to add accompaniment. Maximum 600 characters.

reference_audio_url string* required

Reference song, should contain music and vocals. Must be a .wav or .mp3 file longer than 15 seconds.

TextToMusic26Request#

prompt string* required

A description of the music style, mood, genre, and scenario. 10-300 characters.

lyrics string

Lyrics of the song. Use to separate lines. Supports structure tags: [Intro], [Verse], [Pre Chorus], [Chorus], [Post Chorus], [Hook], [Bridge], [Interlude], [Transition], [Build Up], [Break], [Inst], [Solo], [Outro]. Max 1000 characters. Required when is_instrumental is false. Default value: ""

is_instrumental boolean

When true, generates vocal-free instrumental music.

audio_setting AudioSetting25

Audio configuration settings

TextToMusic20Request#

prompt string* required

A description of the music, specifying style, mood, and scenario. 10-300 characters.

lyrics_prompt string* required

Lyrics of the song. Use n to separate lines. You may add structure tags like [Intro], [Verse], [Chorus], [Bridge], [Outro] to enhance the arrangement. 10-3000 characters.

audio_setting AudioSetting

Audio configuration settings