Minimax H3 Image Edit API Documentation
Playground
Try it on WaveSpeedAI!MiniMax H3 Image Edit enables precise image editing and multi-image composition with up to 16 reference images, supporting flexible creative workflows and high-resolution output. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
MiniMax H3 Image Edit edits and combines images from 1–16 reference images using text instructions. Describe the desired changes and refer to each input image by its order when multiple references are used.
Why Choose This?
-
Multi-reference editing — Use up to
16images in a single editing workflow. -
Natural-language instructions — Describe edits and refer to inputs as image 1, image 2, and so on.
-
Up to 4K output — Choose
1k,2k, or4k. -
Flexible framing — Select an aspect ratio or leave it empty for automatic selection.
-
Multiple output formats — Export as PNG, JPEG, or WebP.
Parameters
| Parameter | Required | Description |
|---|---|---|
| prompt | Yes | Text description of the desired edit. Refer to input images as image 1, image 2, and so on. |
| images | Yes | Between 1 and 16 reference image URLs. Supports JPG, PNG, WEBP, HEIC, and HEIF. Each side must be between 128 and 8192 pixels, and the long side must not exceed 4× the short side. |
| aspect_ratio | No | Output aspect ratio: 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, or 21:9. Leave empty for automatic selection based on the references and instruction. |
| resolution | No | Output resolution: 1k, 2k, or 4k. Default: 1k. |
| output_format | No | Output format: png, jpeg, or webp. Default: png. |
How to Use
- Upload reference images — Provide between
1and16images. - Write an edit instruction — Describe the desired changes and identify images by number when needed.
- Choose framing optional — Select an aspect ratio or leave it empty for automatic selection.
- Choose resolution — Select
1k,2k, or4k. - Choose output format optional — Select PNG, JPEG, or WebP.
- Submit — Generate and retrieve the edited image.
Pricing
Pricing is based on the selected output resolution and the number of input images.
Each input image costs $0.008.
| Resolution | Output Price |
|---|---|
| 1K | $0.03 |
| 2K | $0.03 |
| 4K | $0.09 |
Example Costs
| Resolution | Input Images | Price |
|---|---|---|
| 1K | 1 | $0.038 |
| 1K | 2 | $0.046 |
| 2K | 1 | $0.038 |
| 2K | 4 | $0.062 |
| 4K | 2 | $0.106 |
| 4K | 16 | $0.218 |
1k and 2k use the same output price.
Aspect ratio and output format do not add separate charges.
Best Use Cases
- Multi-image composition — Combine subjects, objects, or visual elements from several references.
- Portrait editing — Adjust clothing, environment, styling, or composition.
- Product editing — Use multiple references to guide product presentation and scene changes.
- Background changes — Place existing subjects into different environments.
- Advertising concepts — Create image variations for campaign and promotional workflows.
- High-resolution editing — Generate edited outputs at up to
4k.
Pro Tips
- Describe both the requested change and any important elements that should remain consistent.
- Refer to images by number when multiple references are used.
- Keep the role of each reference clear in the instruction.
- Use
2kwhen you need a larger output than1kat the same output price. - Use fewer references when several images provide conflicting guidance.
Notes
promptandimagesare required.imagessupports between1and16inputs.- Supported input formats are JPG, PNG, WEBP, HEIC, and HEIF.
- Each image side must be between
128and8192pixels. - Leaving
aspect_ratioempty allows automatic output framing.
Related Models
- MiniMax H3 Image Text-to-Image — Generate images directly from text prompts.
Authentication
For authentication details, please refer to the Authentication Guide.
API Endpoints
Submit Task & Query Result
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
REQUEST_BODY=$(cat <<'JSON'
{
"prompt": "A cinematic ocean wave at sunrise, highly detailed",
"images": [
"https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg"
],
"aspect_ratio": "1:1",
"resolution": "1k",
"output_format": "png"
}
JSON
)
# 1. Submit the prediction once. Never retry this request automatically:
# a retry after an unclear failure can create a second, billed task.
CHECK='The task may already exist. Check History or the predictions list before submitting again.'
if ! SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 \
-X POST "https://api.wavespeed.ai/api/v3/minimax/h3-image/edit" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
-H "Content-Type: application/json" \
-d "${REQUEST_BODY}"); then
printf 'Submit failed. %s\n' "${CHECK}" >&2
exit 1
fi
TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
printf 'Submission response did not contain a prediction id. %s\n' "${CHECK}" >&2
exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"
# 2. Poll until the prediction reaches a final status.
BODY_FILE=$(mktemp)
trap 'rm -f "${BODY_FILE}"' EXIT
while true; do
# Transient errors (429, 5xx) are retried, honoring Retry-After.
HTTP_CODE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 --retry 5 --retry-delay 2 \
--output "${BODY_FILE}" --write-out '%{http_code}' \
"${RESULT_URL}" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" || true)
case "${HTTP_CODE}" in
2??) ;;
000|429|5??) # dropped connection or temporary error: keep polling
printf 'Task %s: HTTP %s, polling again in 10s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
sleep 10; continue ;;
*) printf 'Task %s: HTTP %s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
cat "${BODY_FILE}" >&2; exit 1 ;;
esac
RESULT=$(jq 'if type == "object" and has("data") then .data else . end' "${BODY_FILE}")
STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')
case "${STATUS}" in
completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
failed|cancelled|timeout|deleted)
printf 'Task %s ended with status %s\n' "${PREDICTION_ID}" "${STATUS}" >&2
printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
*) sleep 2 ;;
esac
doneRetry temporary errors only while polling, never the submit request. Errors, retries and timeouts
Parameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| prompt | string | Yes | - | The positive prompt for the generation. | |
| images | array<string> | Yes | - | 1 ~ 16 items | The images to edit, 1 to 16. Refer to them in the prompt as image 1, image 2 and so on, in the order given. JPG, PNG, WEBP, HEIC and HEIF are supported; each side must be 128 to 8192 px and the long side at most 4 times the short side. |
| aspect_ratio | string | No | - | 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, 21:9 | The aspect ratio of the generated image. If not specified, it is determined automatically from the input images and the prompt. |
| resolution | string | No | 1k | 1k, 2k, 4k | The output resolution tier. 1k is about 1 megapixel, 2k about 4 megapixels and 4k about 16 megapixels. 1k and 2k cost the same; 4k is the highest. |
| output_format | string | No | png | png, jpeg, webp | The format of the output image. |
Every model also accepts the global request options enable_sync_mode and enable_base64_output; see their pages for details.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data.id | string | Unique identifier for the prediction, Task Id |
| data.model | string | Model ID used for the prediction |
| data.outputs | array | Output values, usually URL strings; some models return text strings or structured result objects (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Task status. completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses. |
| data.created_at | string | ISO timestamp of when the request was created (e.g., “2023-04-01T12:34:56.789Z”) |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |
Result Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | - | Task ID |
Result Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data | object | The prediction data object containing all details |
| data.id | string | Unique identifier for the prediction |
| data.model | string | Model ID used for the prediction |
| data.outputs | array<string | object> | Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model. |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Status: completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses |
| data.created_at | string | ISO timestamp of when the request was created |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |