Loading API documentation
Generate an image from text with MiniMax H3-Image Highspeed.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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("minimax/h3-image/highspeed/text-to-image", {
input: {
prompt: "A rustic farm-to-table feast on a weathered wooden table, overhead food photograph, warm side light"
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});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("minimax/h3-image/highspeed/text-to-image", {
input: {
prompt: "A rustic farm-to-table feast on a weathered wooden table, overhead food photograph, warm side light"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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("minimax/h3-image/highspeed/text-to-image", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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("minimax/h3-image/highspeed/text-to-image", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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.
prompt string* requiredThe prompt to generate an image from. With prompt expansion on, it is rewritten into the long, complete description the model works best with; with it off, it is used verbatim.
The exact output size. Output area must be 655360 to 20000000 pixels, inclusive, with aspect ratio between 1:3 and 3:1, inclusive.
Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9
Note: For custom image sizes, you can pass the width and height as an object:
"image_size": {
"width": 1280,
"height": 720
}num_images integerThe number of images to generate, all from one expanded prompt. Default value: 1
enable_prompt_expansion booleanRewrite the prompt with a language model into a detailed image description before generation. If expansion fails, the request fails instead of generating from the unexpanded prompt. Default value: true
output_format OutputFormatEnumThe format of the generated image. Default value: "png"
Possible enum values: jpeg, png, webp, jpg
sync_mode booleanIf True, the media will be returned as a data URI and the output data won't be available in the request history.
{
"prompt": "A rustic farm-to-table feast on a weathered wooden table, overhead food photograph, warm side light",
"image_size": {
"height": 2048,
"width": 2048
},
"num_images": 1,
"enable_prompt_expansion": true,
"output_format": "png"
}The generated images.
Validated successful-image token usage, including prompt enhancement in input text tokens.
actual_prompt stringThe expanded prompt when available; null when expansion was disabled or the partner omitted it.
Whether each generated image was flagged by the safety checker.
Seconds spent in each generation stage.
{
"images": [
{
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
]
}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.
width integerThe width of the image
height integerThe height of the image
generated_images integer* requiredtotal_tokens integer* requiredinput_tokens integer* requiredoutput_tokens integer* requiredwidth integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512
image_tokens integer* required