fal-ai/minimax-music
About
Text To Music
1. Calling the API#
Install the client#
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientMigrate to @fal-ai/client
The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.
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", {
input: {
prompt: "## Fast and Limitless
In the heart of the code, where dreams collide,
FAL's the name, taking tech for a ride.
Generative media, blazing the trail,
Fast inference power, we'll never fail.
##",
reference_audio_url: "https://fal.media/files/lion/OOTBTSlxKMH_E8H6hoSlb.mpga"
},
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#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});Protect your API Key
When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
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", {
input: {
prompt: "## Fast and Limitless
In the heart of the code, where dreams collide,
FAL's the name, taking tech for a ride.
Generative media, blazing the trail,
Fast inference power, we'll never fail.
##",
reference_audio_url: "https://fal.media/files/lion/OOTBTSlxKMH_E8H6hoSlb.mpga"
},
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", {
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", {
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);Auto uploads
The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).
Read more about file handling in our file upload guide.
5. Schema#
Input#
prompt string* requiredLyrics 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* requiredReference song, should contain music and vocals. Must be a .wav or .mp3 file longer than 15 seconds.
{
"prompt": "## Fast and Limitless \n In the heart of the code, where dreams collide, \n\nFAL's the name, taking tech for a ride. \nGenerative media, blazing the trail, \n\nFast inference power, we'll never fail.\n##",
"reference_audio_url": "https://fal.media/files/lion/OOTBTSlxKMH_E8H6hoSlb.mpga"
}Output#
The generated music
{
"audio": {
"url": "https://fal.media/files/elephant/N5UNLCwkC2y8v7a3LQLFE_output.mp3"
}
}Other types#
AudioSetting25#
sample_rate SampleRateEnumSample rate of generated audio Default value: "44100"
Possible enum values: 16000, 24000, 32000, 44100
bitrate BitrateEnumBitrate of generated audio Default value: "256000"
Possible enum values: 32000, 64000, 128000, 256000
format FormatEnumAudio format Default value: "mp3"
Possible enum values: mp3, wav, pcm
TextToMusic26Request#
prompt string* requiredA description of the music style, mood, genre, and scenario. 10-2000 characters.
lyrics stringLyrics 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 3500 characters. Required when is_instrumental is false. Default value: ""
lyrics_optimizer booleanWhen true and lyrics is empty, auto-generates lyrics from the prompt.
is_instrumental booleanWhen true, generates vocal-free instrumental music.
Audio configuration settings
TextToMusic25PlusRequest#
prompt string* requiredA description of the music style, mood, genre, and scenario. Max 2000 characters.
lyrics stringLyrics 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 booleanWhen true, generates vocal-free instrumental music.
lyrics_optimizer booleanWhen true and lyrics is empty, auto-generates lyrics from the prompt.
Audio configuration settings
AudioSetting#
sample_rate SampleRateEnumSample rate of generated audio Default value: "44100"
Possible enum values: 8000, 16000, 22050, 24000, 32000, 44100
bitrate BitrateEnumBitrate of generated audio Default value: "256000"
Possible enum values: 32000, 64000, 128000, 256000
format FormatEnumAudio format Default value: "mp3"
Possible enum values: mp3, pcm, flac
MusicCoverRequest#
prompt string* requiredA description of the target cover style: mood, genre, tempo, vocal type. 10-300 characters.
lyrics stringLyrics for the cover. Use
to separate lines. Max 1000 characters. If empty, lyrics are auto-extracted from the reference audio. Default value: ""
audio_url string* requiredURL of the reference audio track to cover. Must be between 6 seconds and 6 minutes long, max 50 MB.
Audio configuration settings
File#
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.
TextToMusic20Request#
prompt string* requiredA description of the music, specifying style, mood, and scenario. 10-300 characters.
lyrics_prompt string* requiredLyrics 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 configuration settings
TextToMusic15Request#
prompt string* requiredLyrics, supports [intro][verse][chorus][bridge][outro] sections. 10-600 characters.
Audio configuration settings
lyrics_prompt string* requiredControl music generation. 10-3000 characters.