MiniMax (Hailuo AI) Text to Image Text to Image
About
Generate images from text prompt using MiniMax API.
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/image-01", {
input: {
prompt: "Man dressed in white t shirt, full-body stand front view image, outdoor, Venice beach sign, full-body image, Los Angeles, Fashion photography of 90s, documentary, Film grain, photorealistic"
},
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/image-01", {
input: {
prompt: "Man dressed in white t shirt, full-body stand front view image, outdoor, Venice beach sign, full-body image, Los Angeles, Fashion photography of 90s, documentary, Film grain, photorealistic"
},
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/image-01", {
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/image-01", {
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* requiredText prompt for image generation (max 1500 characters)
aspect_ratio AspectRatioEnumAspect ratio of the generated image Default value: "1:1"
Possible enum values: 1:1, 16:9, 4:3, 3:2, 2:3, 3:4, 9:16, 21:9
num_images integerNumber of images to generate (1-9) Default value: 1
prompt_optimizer booleanWhether to enable automatic prompt optimization
{
"prompt": "Man dressed in white t shirt, full-body stand front view image, outdoor, Venice beach sign, full-body image, Los Angeles, Fashion photography of 90s, documentary, Film grain, photorealistic",
"aspect_ratio": "1:1",
"num_images": 1
}Output#
Generated images
{
"images": [
{
"file_size": 351366,
"file_name": "image.jpg",
"content_type": "image/jpeg",
"url": "https://v3.fal.media/files/tiger/xLcblZAbiw1kM6ZR_2D-r_image.jpg"
}
]
}Other types#
TextToVideoDirectorRequest#
prompt string* requiredText prompt for video generation. Camera movement instructions can be added using square brackets (e.g. [Pan left] or [Zoom in]). You can use up to 3 combined movements per prompt. Supported movements: Truck left/right, Pan left/right, Push in/Pull out, Pedestal up/down, Tilt up/down, Zoom in/out, Shake, Tracking shot, Static shot. For example: [Truck left, Pan right, Zoom in]. For a more detailed guide, refer https://sixth-switch-2ac.notion.site/T2V-01-Director-Model-Tutorial-with-camera-movement-1886c20a98eb80f395b8e05291ad8645
prompt_optimizer booleanWhether to use the model's prompt optimizer Default value: true
TextToSpeechTurbov25Request#
text string* requiredText to convert to speech (max 5000 characters, minimum 1 non-whitespace character)
Voice configuration settings
Audio configuration settings
language_boost LanguageBoostEnumEnhance recognition of specified languages and dialects
Possible enum values: Persian, Filipino, Tamil, Chinese, Chinese,Yue, English, Arabic, Russian, Spanish, French, Portuguese, German, Turkish, Dutch, Ukrainian, Vietnamese, Indonesian, Japanese, Italian, Korean, Thai, Polish, Romanian, Greek, Czech, Finnish, Hindi, Bulgarian, Danish, Hebrew, Malay, Slovak, Swedish, Croatian, Hungarian, Norwegian, Slovenian, Catalan, Nynorsk, Afrikaans, auto
output_format OutputFormatEnumFormat of the output content (non-streaming only) Default value: "hex"
Possible enum values: url, hex
Custom pronunciation dictionary for text replacement
LoudnessNormalizationSetting#
enabled booleanEnable loudness normalization for the audio Default value: true
target_loudness floatTarget loudness in LUFS (default -18.0) Default value: -18
target_range floatTarget loudness range in LU (default 8.0) Default value: 8
target_peak floatTarget peak level in dBTP (default -0.5). Default value: -0.5
VoiceDesignRequest#
prompt string* requiredVoice description prompt for generating a personalized voice
preview_text string* requiredText for audio preview. Limited to 500 characters. A fee of $30 per 1M characters will be charged for the generation of the preview audio.
MiniMaxTextToImageWithReferenceRequest#
prompt string* requiredText prompt for image generation (max 1500 characters)
image_url string* requiredURL of the subject reference image to use for consistent character appearance
aspect_ratio AspectRatioEnumAspect ratio of the generated image Default value: "1:1"
Possible enum values: 1:1, 16:9, 4:3, 3:2, 2:3, 3:4, 9:16, 21:9
num_images integerNumber of images to generate (1-9) Default value: 1
prompt_optimizer booleanWhether to enable automatic prompt optimization
VoiceSetting#
voice_id stringPredefined voice ID to use for synthesis Default value: "Wise_Woman"
speed floatSpeech speed (0.5-2.0) Default value: 1
vol floatVolume (0-10) Default value: 1
pitch integerVoice pitch (-12 to 12)
emotion EmotionEnumEmotion of the generated speech
Possible enum values: happy, sad, angry, fearful, disgusted, surprised, neutral
english_normalization booleanEnables English text normalization to improve number reading performance, with a slight increase in latency
TextToSpeechHDv25Request#
text string* requiredText to convert to speech (max 5000 characters, minimum 1 non-whitespace character)
Voice configuration settings
Audio configuration settings
language_boost LanguageBoostEnumEnhance recognition of specified languages and dialects
Possible enum values: Persian, Filipino, Tamil, Chinese, Chinese,Yue, English, Arabic, Russian, Spanish, French, Portuguese, German, Turkish, Dutch, Ukrainian, Vietnamese, Indonesian, Japanese, Italian, Korean, Thai, Polish, Romanian, Greek, Czech, Finnish, Hindi, Bulgarian, Danish, Hebrew, Malay, Slovak, Swedish, Croatian, Hungarian, Norwegian, Slovenian, Catalan, Nynorsk, Afrikaans, auto
output_format OutputFormatEnumFormat of the output content (non-streaming only) Default value: "hex"
Possible enum values: url, hex
Custom pronunciation dictionary for text replacement
VoiceDeleteRequest#
voice_id string* requiredThe voice_id of the voice to be deleted
TextToVideoRequest#
prompt string* requiredprompt_optimizer booleanWhether to use the model's prompt optimizer Default value: true
ImageToVideoDirectorRequest#
prompt string* requiredText prompt for video generation. Camera movement instructions can be added using square brackets (e.g. [Pan left] or [Zoom in]). You can use up to 3 combined movements per prompt. Supported movements: Truck left/right, Pan left/right, Push in/Pull out, Pedestal up/down, Tilt up/down, Zoom in/out, Shake, Tracking shot, Static shot. For example: [Truck left, Pan right, Zoom in]. For a more detailed guide, refer https://sixth-switch-2ac.notion.site/T2V-01-Director-Model-Tutorial-with-camera-movement-1886c20a98eb80f395b8e05291ad8645
image_url string* requiredURL of the image to use as the first frame
prompt_optimizer booleanWhether to use the model's prompt optimizer Default value: true
TextToSpeechHD01Request#
text string* requiredText to convert to speech (max 5000 characters, minimum 1 non-whitespace character)
Voice configuration settings
Audio configuration settings
language_boost LanguageBoostEnumEnhance recognition of specified languages and dialects
Possible enum values: Chinese, Chinese,Yue, English, Arabic, Russian, Spanish, French, Portuguese, German, Turkish, Dutch, Ukrainian, Vietnamese, Indonesian, Japanese, Italian, Korean, Thai, Polish, Romanian, Greek, Czech, Finnish, Hindi, Bulgarian, Danish, Hebrew, Malay, Slovak, Swedish, Croatian, Hungarian, Norwegian, Slovenian, Catalan, Nynorsk, Afrikaans, auto
output_format OutputFormatEnumFormat of the output content (non-streaming only) Default value: "hex"
Possible enum values: url, hex
Custom pronunciation dictionary for text replacement
Loudness normalization settings for the audio
TextToSpeechTurboRequest#
text string* requiredText to convert to speech (max 5000 characters, minimum 1 non-whitespace character)
Voice configuration settings
Audio configuration settings
language_boost LanguageBoostEnumEnhance recognition of specified languages and dialects
Possible enum values: Chinese, Chinese,Yue, English, Arabic, Russian, Spanish, French, Portuguese, German, Turkish, Dutch, Ukrainian, Vietnamese, Indonesian, Japanese, Italian, Korean, Thai, Polish, Romanian, Greek, Czech, Finnish, Hindi, Bulgarian, Danish, Hebrew, Malay, Slovak, Swedish, Croatian, Hungarian, Norwegian, Slovenian, Catalan, Nynorsk, Afrikaans, auto
output_format OutputFormatEnumFormat of the output content (non-streaming only) Default value: "hex"
Possible enum values: url, hex
Custom pronunciation dictionary for text replacement
PronunciationDict#
List of pronunciation replacements in format ['text/(pronunciation)', ...]. For Chinese, tones are 1-5. Example: ['燕少飞/(yan4)(shao3)(fei1)']
TextToVideoLiveRequest#
prompt string* requiredprompt_optimizer booleanWhether to use the model's prompt optimizer Default value: true
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.
file_data stringFile data
ImageToVideoRequest#
prompt string* requiredimage_url string* requiredURL of the image to use as the first frame
prompt_optimizer booleanWhether to use the model's prompt optimizer Default value: true
SubjectReferenceRequest#
prompt string* requiredsubject_reference_image_url string* requiredURL of the subject reference image to use for consistent subject appearance
prompt_optimizer booleanWhether to use the model's prompt optimizer Default value: true
AudioSetting#
sample_rate SampleRateEnumSample rate of generated audio Default value: "32000"
Possible enum values: 8000, 16000, 22050, 24000, 32000, 44100
bitrate BitrateEnumBitrate of generated audio Default value: "128000"
Possible enum values: 32000, 64000, 128000, 256000
format FormatEnumAudio format Default value: "mp3"
Possible enum values: mp3, pcm, flac
channel ChannelEnumNumber of audio channels (1=mono, 2=stereo) Default value: "1"
Possible enum values: 1, 2
VoiceCloneRequest#
audio_url string* requiredURL of the input audio file for voice cloning. Should be at least 10 seconds long. To retain the voice permanently, use it with a TTS (text-to-speech) endpoint at least once within 7 days. Otherwise, it will be automatically deleted.
noise_reduction booleanEnable noise reduction for the cloned voice
need_volume_normalization booleanEnable volume normalization for the cloned voice
accuracy floatText validation accuracy threshold (0-1)
text stringText to generate a TTS preview with the cloned voice (optional) Default value: "Hello, this is a preview of your cloned voice! I hope you like it!"
model ModelEnumTTS model to use for preview. Options: speech-02-hd, speech-02-turbo, speech-01-hd, speech-01-turbo Default value: "speech-02-hd"
Possible enum values: speech-02-hd, speech-02-turbo, speech-01-hd, speech-01-turbo
TextToSpeechHDRequest#
text string* requiredText to convert to speech (max 5000 characters, minimum 1 non-whitespace character)
Voice configuration settings
Audio configuration settings
language_boost LanguageBoostEnumEnhance recognition of specified languages and dialects
Possible enum values: Chinese, Chinese,Yue, English, Arabic, Russian, Spanish, French, Portuguese, German, Turkish, Dutch, Ukrainian, Vietnamese, Indonesian, Japanese, Italian, Korean, Thai, Polish, Romanian, Greek, Czech, Finnish, Hindi, Bulgarian, Danish, Hebrew, Malay, Slovak, Swedish, Croatian, Hungarian, Norwegian, Slovenian, Catalan, Nynorsk, Afrikaans, auto
output_format OutputFormatEnumFormat of the output content (non-streaming only) Default value: "hex"
Possible enum values: url, hex
Custom pronunciation dictionary for text replacement