MiniMax H3 Image Edit transforms and combines up to 16 reference images using text instructions, supporting targeted edits, style changes, and multi-image composition. Its unified generation and editing model produces detailed results at custom output sizes up to 20 megapixels.

minimax/h3-image/edit

Inference

Commercial use

Partner

Schema

Playground API Examples

Try free

minimax/h3-image/edit

Schema

Try free

minimax/h3-image/edit

Inference

Commercial use

Partner

Schema

Playground API Examples

Try free

About

Edit or compose images with MiniMax H3-Image.

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

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.

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("minimax/h3-image/edit", {
  input: {
    prompt: "Put a red knitted scarf on the dog and keep everything else",
    image_urls: ["https://storage.googleapis.com/falserverless/example_inputs/dog.png"]
  },
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

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#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

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("minimax/h3-image/edit", {
  input: {
    prompt: "Put a red knitted scarf on the dog and keep everything else",
    image_urls: ["https://storage.googleapis.com/falserverless/example_inputs/dog.png"]
  },
  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("minimax/h3-image/edit", {
  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("minimax/h3-image/edit", {
  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* required

The edit to make. Refer to the input images as Image 1, Image 2, ... in image_urls order.

image_urls list<string>* required

The images to edit or compose, at most 16, in the order the prompt cites them. Each side must be 128 to 8192 pixels.

image_size ImageSize | Enum

The size of the generated image. Output area must be 655360 to 20000000 pixels, inclusive, with aspect ratio between 1:3 and 3:1, inclusive. auto keeps the first image's aspect ratio, limited to 1:3..3:1, within a 2048x2048 area. Default value: auto

Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto

Note: For custom image sizes, you can pass the width and height as an object:

"image_size": {
  "width": 1280,
  "height": 720
}

num_images integer

The number of images to generate, all from one expanded prompt. Default value: 1

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png, webp, jpg

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

{
  "prompt": "Put a red knitted scarf on the dog and keep everything else",
  "image_urls": [
    "https://storage.googleapis.com/falserverless/example_inputs/dog.png"
  ],
  "image_size": "auto",
  "num_images": 1,
  "output_format": "png"
}

Output#

images list<ImageFile>* required

The generated images.

usage ImageUsage

Validated successful-image token usage, including prompt enhancement in input text tokens.

actual_prompt string

The expanded prompt when available; null when expansion was disabled or the partner omitted it.

has_nsfw_concepts list<boolean>* required

Whether each generated image was flagged by the safety checker.

timings Timings* required

Seconds spent in each generation stage.

{
  "images": [
    {
      "url": "",
      "content_type": "image/png",
      "file_name": "z9RV14K95DvU.png",
      "file_size": 4404019
    }
  ]
}

Other types#

ImageFile#

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.

width integer

The width of the image

height integer

The height of the image

ImageUsage#

generated_images integer* required

total_tokens integer* required

input_tokens integer* required

output_tokens integer* required

input_tokens_details InputTokenDetails* required

output_tokens_details TokenDetails* required

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

InputTokenDetails#

image_tokens integer* required

text_tokens integer* required

TokenDetails#

image_tokens integer* required

Related Models

About

Edit or compose images with MiniMax H3-Image.

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

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.

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("minimax/h3-image/edit", {
  input: {
    prompt: "Put a red knitted scarf on the dog and keep everything else",
    image_urls: ["https://storage.googleapis.com/falserverless/example_inputs/dog.png"]
  },
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

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

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

Protect your API Key

3. Queue#

Long-running requests

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("minimax/h3-image/edit", {
  input: {
    prompt: "Put a red knitted scarf on the dog and keep everything else",
    image_urls: ["https://storage.googleapis.com/falserverless/example_inputs/dog.png"]
  },
  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("minimax/h3-image/edit", {
  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("minimax/h3-image/edit", {
  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)#

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* required

The edit to make. Refer to the input images as Image 1, Image 2, ... in image_urls order.

image_urls list<string>* required

The images to edit or compose, at most 16, in the order the prompt cites them. Each side must be 128 to 8192 pixels.

image_size ImageSize | Enum

Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto

Note: For custom image sizes, you can pass the width and height as an object:

"image_size": {
  "width": 1280,
  "height": 720
}

num_images integer

The number of images to generate, all from one expanded prompt. Default value: 1

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png, webp, jpg

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

{
  "prompt": "Put a red knitted scarf on the dog and keep everything else",
  "image_urls": [
    "https://storage.googleapis.com/falserverless/example_inputs/dog.png"
  ],
  "image_size": "auto",
  "num_images": 1,
  "output_format": "png"
}

Output#

images list<ImageFile>* required

The generated images.

usage ImageUsage

Validated successful-image token usage, including prompt enhancement in input text tokens.

actual_prompt string

The expanded prompt when available; null when expansion was disabled or the partner omitted it.

has_nsfw_concepts list<boolean>* required

Whether each generated image was flagged by the safety checker.

timings Timings* required

Seconds spent in each generation stage.

{
  "images": [
    {
      "url": "",
      "content_type": "image/png",
      "file_name": "z9RV14K95DvU.png",
      "file_size": 4404019
    }
  ]
}

Other types#

ImageFile#

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.

width integer

The width of the image

height integer

The height of the image

ImageUsage#

generated_images integer* required

total_tokens integer* required

input_tokens integer* required

output_tokens integer* required

input_tokens_details InputTokenDetails* required

output_tokens_details TokenDetails* required

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

InputTokenDetails#

image_tokens integer* required

text_tokens integer* required

TokenDetails#

image_tokens integer* required

Related Models

MiniMax H3 Image Edit Image to Image API Docs | fal

minimax/h3-image/edit

Table of contents

Table of contents

minimax/h3-image/edit

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

ImageFile#

ImageUsage#

ImageSize#

InputTokenDetails#

TokenDetails#

Related Models

Table of contents

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

ImageFile#

ImageUsage#

ImageSize#

InputTokenDetails#

TokenDetails#

Related Models