Skip to navigation

MiniMax H3 Image

Generate or edit an image from text and up to 16 reference images, at 1K, 2K or 4K or at an exact pixel size, billed by the tokens each render uses.

  • Asynchronous: the create call returns a task ID in a moment; the image arrives when the task succeeds.
  • One image per task. To get several images, create several tasks.
  • Text to image, or edit and combine up to 16 reference images given as public HTTPS links.
  • Choose the frame with resolution and aspect_ratio, or with one exact size such as 2720x1536. Never both. aspect_ratio defaults to auto, which lets the model choose the frame from the prompt and any images.
  • Billed by tokens: text input (the prompt, including MiniMax’s prompt enhancement), reference-image input and image output, each at its own per-1M-token rate. The per-image prices below are estimates. The default resolution is 4K; 1K and 2K use the same output tokens and so cost the same.
  • The result is a png (the default), jpeg or webp file, chosen with output_format. A failed task costs nothing.

MiniMax H3 Image is MiniMax’s image model, billed by tokens at MiniMax’s list rates less 30%. For the Highspeed line, which takes the same request at higher per-token rates for image input and image output, use minimax-h3-image-highspeed.

POST/v1/images/tasksTry it

Opens this model in the API Explorer. Enter your BeatAPI API key to create a task: the call is real and is billed to your own balance.

Model IDs

Both MiniMax H3 Image models use this endpoint and take the same fields. The values below come straight from the gateway contract.

Model IDresolutionMax imagesoutput_formatAbout it
minimax-h3-image1K, 2K, 4K16png, jpeg, webpMiniMax’s image model. See the price table for its per-token rates.
minimax-h3-image-highspeed1K, 2K, 4K16png, jpeg, webpThe Highspeed line. Same fields and limits; higher rates for image input and image output, see the price table.

Endpoint and authentication

POST https://api.beatapi.io/v1/images/tasks

Authorization string Required

Your BeatAPI API key, sent as Bearer <BEATAPI_API_KEY>. Create keys in the Dashboard. Keep keys on your server; never ship them in a browser or mobile app.

Send the body as JSON with Content-Type: application/json. Idempotency-Key is optional: send a unique value (at most 255 characters) per logical request and reuse it only to retry that exact body. Within 24 hours a retry with the same key and body returns the first response again with Idempotent-Replayed: true; the same key with a different body returns 409 idempotency_conflict. Responses other than 2xx are not stored, so a retry after a 400 or 402 runs again.

How a request works

1

Create the task

POST the parameters below to the endpoint. A 201 means the task was accepted and its price reserved from your balance; the work runs in the background. Save data.id.

2

Wait for it to finish

Call GET /v1/tasks/{task_id} and wait data.poll_after_seconds between calls (5 s for images, 8 s for videos) until status is succeeded or failed. Or register a webhook for task.succeeded and task.failed; keep polling as the fallback, because a task stopped by the processing timeout sends no event.

3

Save the result

On succeeded, download every data.output.media[].url and store the files you need; BeatAPI does not promise how long result URLs stay available. On failed, read data.error_code and data.error_message: the reserved amount was returned to your balance, and data.retryable says whether sending the same request again can succeed.

Input modes

ModeRequired inputsNotes
Text to imagemodel, promptLeave out images.
Edit or combine imagesmodel, prompt, images1 to 16 public HTTPS image links. Describe in prompt what to change, keep or combine.

Request parameters

model string Required

The model to run.

Value: minimax-h3-image

If the value is wrong

  • Missing: "model" is required
  • Unknown model ID: "model" minimax-image-9 is not catalogued
  • A video model sent to this endpoint: "model" seedance-2.5 is served by POST /v1/videos/tasks, not this endpoint

prompt string Required

What to draw, or what to change in the reference images. Plain language works best: subject, style, lighting, composition, and any text that must appear in the image.

Length: 1–5000 characters

  • Length is counted in characters (a CJK character counts as one).
  • When you send images, say which image does what, for example “Use the first image for the product and the second for the background”.
  • MiniMax’s prompt enhancement is on for every order. It adds text tokens to the input, which are billed at the text-input rate.

If the value is wrong

  • Missing: "prompt" is required
  • Empty or longer than the limit: "prompt" has an unsupported length
  • Not a string: "prompt" must be a string

images string[] Optional

Reference images to edit or combine. Sending this field switches the request from text-to-image to image editing.

Items: 1–16
Each item is a public https:// URL. For a local file, upload it first with POST /v1/files and pass the returned data.url.

  • Each link must return the image file itself (PNG, JPEG or WebP) over public HTTPS, at most 50 MB. The gateway downloads the first bytes of every link before creating the task and recognises the type from those bytes, not from the file name or Content-Type.
  • Links to web pages, login walls, expired signed URLs or hotlink-protected hosts are refused, because they do not return an image.
  • Positions in error messages are 0-based: images[0] is the first link.
  • The reference images are billed as image input, at their own per-1M-token rate (see Pricing).

If the value is wrong

  • More than the maximum: "images" accepts at most 16 items
  • An empty array: "images" requires at least 1 item
  • Not an https:// link: "images[0]" must be a public HTTPS URL
  • A private or unsafe address: "images[0]" must be a publicly reachable HTTPS image URL
  • The host answers with a 4xx error: "images[0]" could not be downloaded: the URL returned HTTP 404
  • The link returns something other than PNG, JPEG or WebP: "images[0]" is not a PNG, JPEG or WebP image: the URL returned text/html
  • Larger than 50 MB: "images[2]" is 63.4 MB; images must be 50 MB or smaller

Example

"images": [
"https://cdn.beatapi.io/samples/smart-bottle.png",
"https://cdn.beatapi.io/samples/neon-singer.png"
]

aspect_ratio string OptionalDefault: auto

Shape of the image as width:height. Send it together with resolution, or leave both out and send size.

Allowed values: auto, 1:1, 3:2, 2:3, 4:3, 3:4, 5:4, 4:5, 16:9, 9:16, 2:1, 1:2, 3:1, 1:3, 21:9, 9:21
Default: auto

  • The default is auto: the model chooses the frame from the prompt and from the reference images, if any. Name a ratio when the shape matters.
  • Panoramic shapes 2:1, 1:2, 3:1, 1:3, 21:9 and 9:21 are accepted. The widest or tallest frame is 3:1.
  • Not allowed together with size.

If the value is wrong

  • A value not in the list: "aspect_ratio" must be one of: [auto 1:1 3:2 2:3 4:3 3:4 5:4 4:5 16:9 9:16 2:1 1:2 3:1 1:3 21:9 9:21]
  • Sent together with size: "size" already fixes the output; do not send "aspect_ratio" with it

resolution string OptionalDefault: 4K

Size class of the image: 1K, 2K or 4K. A larger class gives a larger image; the exact pixel size depends on aspect_ratio and is decided by the model.

Allowed values: 1K, 2K, 4K
Default: 4K

  • If you leave the field out, 4K is used.
  • 1K and 2K use the same output tokens, so they cost the same. 4K uses about four times as many and costs more (see Pricing).
  • Use the capital K: 2k is refused.
  • This page does not promise exact pixel dimensions for a class. If you need an exact frame, send size.
  • Not allowed together with size, which carries its own size.

If the value is wrong

  • A value not in the list: "resolution" must be one of: [1K 2K 4K]
  • Sent together with size: "size" already fixes the output; do not send "resolution" with it

size string Optional

An exact output frame as WIDTHxHEIGHT in pixels, for example 2720x1536. It replaces resolution and aspect_ratio.

  • The total must be between 655,360 and 20,000,000 pixels, and the long edge at most three times the short edge. There is no edge multiple to respect.
  • The frame is rendered exactly as asked and never rounded.
  • The separator can be x, X or ×; spaces around it are ignored.
  • Billing follows the tokens the render uses: a larger frame uses more output tokens and so costs more (see Pricing).
  • Do not send resolution or aspect_ratio with it, even the default values.

If the value is wrong

  • Not a string: "size" must be a string
  • Not in WIDTHxHEIGHT form (a number alone, auto, a comma): "size" must be WIDTHxHEIGHT in pixels, for example 2720x1536
  • Too few or too many pixels: "size" must have between 655,360 and 20,000,000 pixels; 512x512 has 262,144
  • Wider or taller than 3:1: "size" must not be wider or taller than 3:1
  • Sent with resolution: "size" already fixes the output; do not send "resolution" with it
  • Sent with aspect_ratio: "size" already fixes the output; do not send "aspect_ratio" with it

Example

"size": "2720x1536"

output_format string OptionalDefault: png

The file type of the image: png, jpeg or webp.

Allowed values: png, jpeg, webp
Default: png

  • The default is png.
  • The format does not change the price.
  • Read mime_type on the output for the type of the stored file.

If the value is wrong

  • A value not in the list: "output_format" must be one of: [png jpeg webp]

Example

"output_format": "webp"

The gateway also checks these combinations before creating the task:

  • size is WIDTHxHEIGHT and replaces resolution and aspect_ratio: 655,360-20,000,000 pixels in total, at most 3:1; it is rendered exactly, never rounded
  • billed per token at the listed rates for the tokens each render uses (text input including prompt enhancement, reference images, image output); the listed per-image prices are estimates; 1K and 2K use the same output tokens
  • aspect_ratio auto lets the model choose the frame from the prompt and any images

Input media limits

The gateway reads every input before the task is created and refuses one outside these limits with a 400 bad_request that names the input. Nothing is charged.

  • Reference images: PNG, JPEG or WebP, recognised from the file content; at most 50 MB each (decimal megabytes; checked when the host states the size); 1 to 16 links. GIF, HEIC and SVG are refused.
  • No pixel or aspect-ratio limit is checked on the reference images themselves.
  • If a host does not answer in time, the link is not refused at create. The gateway fetches it again when the task is dispatched, and a link that still cannot be fetched fails the task, which is refunded.
  • Have a local file? Upload it with POST /v1/files and pass the returned data.url.

Choose the frame: resolution and aspect_ratio, or size

There are two ways to say how big and how wide the image is, and they exclude each other:

  • Tier and ratio. Send resolution (1K, 2K or 4K) and, if you want a shape, aspect_ratio. Leave both out and you get 4K and auto: the model chooses the frame.
  • Exact size. Send size alone, for example 2720x1536: 655,360 to 20,000,000 pixels, at most 3:1, rendered exactly.

Sending size with resolution or with aspect_ratio is refused with "size" already fixes the output; do not send "resolution" with it (or "aspect_ratio"). The check applies even when the other field holds its default value.

What the estimate assumes

The per-image prices in the table below are estimates. Each one assumes 3,000 text tokens (the prompt and MiniMax’s prompt enhancement) and the output tokens of the tier, and no reference images. What you are charged is settled to the tokens the render actually used.

resolutionOutput tokens in the estimate
1K4,096
2K4,096
4K16,384

Fields this model does not accept

The image endpoint knows a few fields that other image models use. Sending one of them here is refused instead of being ignored, so you never pay for a setting that had no effect:

  • background, quality, seed, enhance_prompt → field "background" is not supported by model minimax-h3-image (with the field you sent and the model you called).
  • Any other unknown field, such as n or moderation → unknown field: n. There is no n: one task makes one image.

Request examples

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "minimax-h3-image",
"prompt": "A minimalist product photo of a glass water bottle on wet black stone, soft rim light, shallow depth of field",
"aspect_ratio": "3:2",
"resolution": "2K"
}'

Text to image

A 2K landscape image from a prompt, with a tier and a ratio.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "minimax-h3-image",
"prompt": "A minimalist product photo of a glass water bottle on wet black stone, soft rim light, shallow depth of field",
"aspect_ratio": "3:2",
"resolution": "2K"
}'

Let the model choose the frame

Only a prompt: resolution is 4K and aspect_ratio is auto, so the model chooses the frame.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "minimax-h3-image",
"prompt": "A tall, narrow travel poster of a mountain railway at dawn, bold flat colours"
}'

Edit one image

Change the background and keep the product.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "minimax-h3-image",
"prompt": "Keep the bottle exactly as it is. Replace the background with a sunlit kitchen counter and add a soft reflection under the bottle.",
"images": [
"https://cdn.beatapi.io/samples/smart-bottle.png"
],
"aspect_ratio": "1:1",
"resolution": "2K"
}'

Combine several images

Name each reference in the prompt by its position.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "minimax-h3-image",
"prompt": "Place the bottle from the first image on a neon-lit stage like the one in the second image. Keep the bottle label readable.",
"images": [
"https://cdn.beatapi.io/samples/smart-bottle.png",
"https://cdn.beatapi.io/samples/neon-singer.png"
],
"aspect_ratio": "16:9",
"resolution": "2K"
}'

Exact size

A 2720x1536 frame as WebP. size stands alone: no resolution, no aspect_ratio.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "minimax-h3-image",
"prompt": "A flat illustration of a lighthouse on a cliff at dawn, pastel colours, clean shapes",
"size": "2720x1536",
"output_format": "webp"
}'

Responses

Create a task (201)

The task object. output is null until the task succeeds. Fields marked “while running” disappear once the task finishes.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "image",
"capability_id": "minimax-h3-image",
"capability_version": 1,
"media_type": "image",
"model": "minimax-h3-image",
"status": "queued",
"stage": "queued",
"created_at": 1791993600,
"updated_at": 1791993600,
"completed_at": null,
"poll_after_seconds": 5,
"output": null,
"usage": {
"credits_reserved": 0.015725,
"credits_settled": 0,
"credits_refunded": 0,
"credits_charged": 0.015725
},
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": null,
"error_message": null
}
}
FieldTypeDescription
data.idstringTask ID: task_ followed by 32 letters and digits. Use it to poll and to match webhook events.
data.objectstringAlways task.
data.task_kindstringimage or video.
data.capability_idstringThe model ID you sent.
data.capability_versionintegerContract version of the model, currently 1.
data.media_typestringimage or video.
data.modelstringThe model ID you sent (same as capability_id).
data.statusstringqueued, processing, succeeded or failed. Only the last two are final.
data.stagestringRepeats status; kept for older clients.
data.created_atintegerWhen the task was created, Unix seconds.
data.updated_atintegerLast change, Unix seconds.
data.completed_atinteger | nullWhen the task finished, Unix seconds; null while it runs.
data.poll_after_secondsintegerWhile running: how long to wait before the next poll (5 for images, 8 for videos).
data.typical_secondsobjectWhile running, when enough recent tasks exist: p50 and p90 completion times in seconds over the last window, from samples tasks.
data.outputobject | nullThe result; null until status is succeeded. See the output fields below.
data.usage.credits_reservednumberUSD held from your balance when the task was created.
data.usage.credits_chargednumberUSD this task costs; 0 on a failed task.
data.usage.credits_settlednumberUSD finally taken; set when the task succeeds, otherwise 0.
data.usage.credits_refundednumberUSD returned to your balance; equals the reservation on a failed task once the refund is recorded.
data.usage.billable_duration_secondsintegerVideo only: the seconds the price is based on. Absent when the model reports no duration.
data.request_idstringRequest ID. Include it when you contact support.
data.error_codestring | nullFailure code; null unless the task failed.
data.error_messagestring | nullWhat went wrong and what to change; null unless the task failed.

Finished task

GET /v1/tasks/{task_id} returns HTTP 200 with status: "succeeded" and the result in data.output.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "image",
"capability_id": "minimax-h3-image",
"capability_version": 1,
"media_type": "image",
"model": "minimax-h3-image",
"status": "succeeded",
"stage": "succeeded",
"created_at": 1791993600,
"updated_at": 1791993690,
"completed_at": 1791993690,
"output": {
"media": [
{
"type": "image",
"url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.png",
"mime_type": "image/png"
}
],
"r2_url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.png"
},
"usage": {
"credits_reserved": 0.015725,
"credits_settled": 0.015725,
"credits_refunded": 0,
"credits_charged": 0.015725
},
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": null,
"error_message": null
}
}

Output fields

FieldTypeDescription
output.mediaobject[]The generated files; one item for this model.
output.media[].typestringAlways image.
output.media[].urlstringHTTPS link to the stored image. Download and keep it; no retention period is promised.
output.media[].mime_typestringThe type of the stored file: image/png, image/jpeg or image/webp, following output_format.
output.r2_urlstringThe first media URL again, for older clients. Read media instead.

Failed task

A failed task is still HTTP 200 on GET /v1/tasks/{task_id}: the failure is in the body. The reservation is returned in full, so nothing is charged.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "image",
"capability_id": "minimax-h3-image",
"capability_version": 1,
"media_type": "image",
"model": "minimax-h3-image",
"status": "failed",
"stage": "failed",
"created_at": 1791993600,
"updated_at": 1791993690,
"completed_at": 1791993690,
"output": null,
"usage": {
"credits_reserved": 0.015725,
"credits_settled": 0,
"credits_refunded": 0.015725,
"credits_charged": 0
},
"retryable": true,
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": "processing_failed",
"error_message": "The task failed during processing on our side. Retry; a failed task is refunded."
}
}
FieldTypeDescription
data.error_codestringOne of bad_request and content_policy_violation (change the request) or processing_unavailable, processing_timeout, processing_failed and result_transfer_failed (try again later). See Errors.
data.error_messagestringA sentence that names the problem and the fix.
data.retryablebooleanPresent only on a failed task: true when the same request can succeed if you send it again.
data.usageobjectOnce the refund is recorded (normally at the moment the task fails): credits_charged and credits_settled are 0, and credits_refunded equals credits_reserved.

Complete example

Create a task, wait for it with the server’s polling hint, and print the result URLs. Set BEATAPI_API_KEY in your environment and install requests.

import os
import time
import uuid
import requests
API = "https://api.beatapi.io"
HEADERS = {"Authorization": f"Bearer {os.environ['BEATAPI_API_KEY']}"}
def create_task(body: dict) -> dict:
# One Idempotency-Key per logical request: a retry with the same key cannot create a second task.
headers = {**HEADERS, "Idempotency-Key": str(uuid.uuid4())}
for attempt in range(3):
response = requests.post(f"{API}/v1/images/tasks", headers=headers, json=body, timeout=60)
if response.status_code in (429, 503) and attempt < 2:
time.sleep(int(response.headers.get("Retry-After", 10)))
continue
break
try:
payload = response.json()
except ValueError: # an edge error page is not JSON
response.raise_for_status()
raise
if not response.ok:
error = payload["error"]
raise RuntimeError(f"{response.status_code} {error['code']}: {error['message']} (request_id={error.get('request_id')})")
return payload["data"]
def wait_for_task(task_id: str, timeout_seconds: int = 1800) -> dict:
deadline = time.monotonic() + timeout_seconds
while time.monotonic() < deadline:
response = requests.get(f"{API}/v1/tasks/{task_id}", headers=HEADERS, timeout=30)
if response.status_code == 429 or response.status_code >= 500:
time.sleep(int(response.headers.get("Retry-After", 10)))
continue
response.raise_for_status()
task = response.json()["data"]
if task["status"] in ("succeeded", "failed"):
return task
time.sleep(task.get("poll_after_seconds", 5))
raise TimeoutError(f"task {task_id} is still running; keep polling later")
task = create_task({
"model": "minimax-h3-image",
"prompt": "A minimalist product photo of a glass water bottle on wet black stone, soft rim light, shallow depth of field",
"aspect_ratio": "3:2",
"resolution": "2K"
})
print("created", task["id"])
task = wait_for_task(task["id"])
if task["status"] == "failed":
raise SystemExit(f"{task['error_code']}: {task['error_message']}")
for item in task["output"]["media"]:
print(item["url"])

Billing

  • Billed by tokens at the per-1M-token rates in the table below: text input (the prompt, including MiniMax’s prompt enhancement), image input (the reference images in images) and image output. The model counts the tokens; the resolution or size, the prompt and the reference images all change the count.
  • The per-image prices are estimates for one render of each resolution without reference images, at 3,000 text tokens and the output tokens in the table above. 1K and 2K use the same output tokens and so have the same estimate.
  • When the task is created, the estimate for its tier is reserved from your balance, and from the key’s quota if it has one. When it succeeds, the charge is settled to the tokens the render actually used, so the final data.usage can differ from the reservation. A request refused before a task exists costs nothing.
  • A failed task is refunded in full.

Current list prices, the same as on Pricing. An account with a negotiated discount pays less; data.usage on the task always shows the amount actually charged.

OptionList price (USD)
1 image · 1K · estimate at the measured tokens$0.015725
1 image · 2K · estimate at the measured tokens$0.015725
1 image · 4K · estimate at the measured tokens$0.048411
Text input · per 1M tokens$1.61
Image input · per 1M tokens$1.05
Image output · per 1M tokens$2.66

Common errors

Error or symptomCauseFix
400 "size" already fixes the output; do not send "resolution" with itsize was sent together with resolution or aspect_ratio, even at its default value.Send size alone, or resolution and aspect_ratio without size.
400 "size" must have between 655,360 and 20,000,000 pixels; 512x512 has 262,144The frame has too few or too many pixels.Keep the total between 655,360 and 20,000,000 pixels.
400 "size" must not be wider or taller than 3:1The long edge is more than three times the short edge.Use a frame of at most 3:1, for example 3000x1000.
400 "resolution" must be one of: [1K 2K 4K]Lower-case 2k, 8K, or a pixel size such as 2048x2048 in resolution.Send 1K, 2K or 4K, or use the size field for pixels.
400 "output_format" must be one of: [png jpeg webp]gif, jpg or another file type.Send png, jpeg or webp, or leave the field out for png.
400 field "background" is not supported by model minimax-h3-imageA field from another image model (background, quality, seed, enhance_prompt).Remove the field.
400 unknown field: nAsking for several images in one task.Remove n and create one task per image.
400 "images[0]" must be a public HTTPS URLAn http:// link, a data: URI or a local path.Host the file on HTTPS, or upload it with POST /v1/files and use data.url.
400 "images[1]" is not a PNG, JPEG or WebP image: the URL returned text/htmlThe link opens a web page, a login page or an expired signed URL instead of the file.Link directly to the image file.
400 "images[0]" could not be downloaded: the URL returned HTTP 403The host blocks downloads from servers (hotlink protection or private bucket).Make the file public, or upload it with POST /v1/files.
The charge differs from the per-image priceThe charge is settled to the tokens the render used; the per-image price is an estimate.Read data.usage on the finished task.
Task failed with content_policy_violationThe prompt, a reference image or the generated image was refused by moderation.Change the prompt or the image. Retrying unchanged fails again; nothing is charged.
Task failed with processing_timeoutThe image did not finish within the processing window.Retry; the failed task was refunded.

HTTP errors at a glance

Errors before a task exists arrive as a non-2xx response, and nothing is charged. Branch on error.code or error.retryable; message names the problem. The full list and retry policy are on Errors.

{
"error": {
"code": "bad_request",
"message": "\"prompt\" is required",
"retryable": false,
"request_id": "req_5f0c2a9e4b7d4e31"
}
}
HTTP statuserror.codeWhat to do
400bad_request, content_policy_violationFix the request; the message names the field. Do not retry unchanged.
401missing_api_key, invalid_api_key (older clients may see unauthorized)Send a valid key as Authorization: Bearer <key>.
402insufficient_creditsTop up, or raise the key’s quota, then send it again.
403forbiddenThe key or account may not use this model (for example, free credit only covers some models). Do not retry unchanged.
404not_foundOn GET /v1/tasks/{task_id}: the task does not exist for this key’s account. Check the ID.
409idempotency_conflictUse a new Idempotency-Key, or wait for the first request with this key to finish.
429rate_limit_exceededWait Retry-After seconds (also error.retry_after_seconds), then retry.
500internal_errorRetry with backoff; contact support with request_id if it continues.
503processing_unavailable, processing_timeout, processing_failed, result_transfer_failedNothing was charged. Retry with exponential backoff.

Authentication

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

Headers

Idempotency-KeystringOptional<=255 characters

Send the body as JSON with Content-Type: application/json. Idempotency-Key is optional: send a unique value (at most 255 characters) per logical request and reuse it only to retry that exact body. Within 24 hours a retry with the same key and body returns the first response again with Idempotent-Replayed: true; the same key with a different body returns 409 idempotency_conflict. Responses other than 2xx are not stored, so a retry after a 400 or 402 runs again.

Request

This endpoint expects an object.
modelenumRequired

The model to run.

Value: minimax-h3-image

If the value is wrong

  • Missing: "model" is required
  • Unknown model ID: "model" minimax-image-9 is not catalogued
  • A video model sent to this endpoint: "model" seedance-2.5 is served by POST /v1/videos/tasks, not this endpoint
Allowed values:
promptstringRequired1-5000 characters

What to draw, or what to change in the reference images. Plain language works best: subject, style, lighting, composition, and any text that must appear in the image.

Length: 1–5000 characters

  • Length is counted in characters (a CJK character counts as one).
  • When you send images, say which image does what, for example “Use the first image for the product and the second for the background”.
  • MiniMax’s prompt enhancement is on for every order. It adds text tokens to the input, which are billed at the text-input rate.

If the value is wrong

  • Missing: "prompt" is required
  • Empty or longer than the limit: "prompt" has an unsupported length
  • Not a string: "prompt" must be a string
aspect_ratioenumOptionalDefaults to auto

Shape of the image as width:height. Send it together with resolution, or leave both out and send size.

Allowed values: auto, 1:1, 3:2, 2:3, 4:3, 3:4, 5:4, 4:5, 16:9, 9:16, 2:1, 1:2, 3:1, 1:3, 21:9, 9:21

Default: auto

  • The default is auto: the model chooses the frame from the prompt and from the reference images, if any. Name a ratio when the shape matters.
  • Panoramic shapes 2:1, 1:2, 3:1, 1:3, 21:9 and 9:21 are accepted. The widest or tallest frame is 3:1.
  • Not allowed together with size.

If the value is wrong

  • A value not in the list: "aspect_ratio" must be one of: [auto 1:1 3:2 2:3 4:3 3:4 5:4 4:5 16:9 9:16 2:1 1:2 3:1 1:3 21:9 9:21]
  • Sent together with size: "size" already fixes the output; do not send "aspect_ratio" with it
imageslist of stringsOptional

Reference images to edit or combine. Sending this field switches the request from text-to-image to image editing.

Items: 1–16

Each item is a public https:// URL. For a local file, upload it first with POST /v1/files and pass the returned data.url.

  • Each link must return the image file itself (PNG, JPEG or WebP) over public HTTPS, at most 50 MB. The gateway downloads the first bytes of every link before creating the task and recognises the type from those bytes, not from the file name or Content-Type.
  • Links to web pages, login walls, expired signed URLs or hotlink-protected hosts are refused, because they do not return an image.
  • Positions in error messages are 0-based: images[0] is the first link.
  • The reference images are billed as image input, at their own per-1M-token rate (see Pricing).

If the value is wrong

  • More than the maximum: "images" accepts at most 16 items
  • An empty array: "images" requires at least 1 item
  • Not an https:// link: "images[0]" must be a public HTTPS URL
  • A private or unsafe address: "images[0]" must be a publicly reachable HTTPS image URL
  • The host answers with a 4xx error: "images[0]" could not be downloaded: the URL returned HTTP 404
  • The link returns something other than PNG, JPEG or WebP: "images[0]" is not a PNG, JPEG or WebP image: the URL returned text/html
  • Larger than 50 MB: "images[2]" is 63.4 MB; images must be 50 MB or smaller

Example

"images": [
  "https://cdn.beatapi.io/samples/smart-bottle.png",
  "https://cdn.beatapi.io/samples/neon-singer.png"
]
output_formatenumOptionalDefaults to png

The file type of the image: png, jpeg or webp.

Allowed values: png, jpeg, webp

Default: png

  • The default is png.
  • The format does not change the price.
  • Read mime_type on the output for the type of the stored file.

If the value is wrong

  • A value not in the list: "output_format" must be one of: [png jpeg webp]

Example

"output_format": "webp"
Allowed values:
resolutionenumOptionalDefaults to 4K

Size class of the image: 1K, 2K or 4K. A larger class gives a larger image; the exact pixel size depends on aspect_ratio and is decided by the model.

Allowed values: 1K, 2K, 4K

Default: 4K

  • If you leave the field out, 4K is used.
  • 1K and 2K use the same output tokens, so they cost the same. 4K uses about four times as many and costs more (see Pricing).
  • Use the capital K: 2k is refused.
  • This page does not promise exact pixel dimensions for a class. If you need an exact frame, send size.
  • Not allowed together with size, which carries its own size.

If the value is wrong

  • A value not in the list: "resolution" must be one of: [1K 2K 4K]
  • Sent together with size: "size" already fixes the output; do not send "resolution" with it
Allowed values:
sizestringOptionalformat: "image-size"

An exact output frame as WIDTHxHEIGHT in pixels, for example 2720x1536. It replaces resolution and aspect_ratio.

  • The total must be between 655,360 and 20,000,000 pixels, and the long edge at most three times the short edge. There is no edge multiple to respect.
  • The frame is rendered exactly as asked and never rounded.
  • The separator can be x, X or ×; spaces around it are ignored.
  • Billing follows the tokens the render uses: a larger frame uses more output tokens and so costs more (see Pricing).
  • Do not send resolution or aspect_ratio with it, even the default values.

If the value is wrong

  • Not a string: "size" must be a string
  • Not in WIDTHxHEIGHT form (a number alone, auto, a comma): "size" must be WIDTHxHEIGHT in pixels, for example 2720x1536
  • Too few or too many pixels: "size" must have between 655,360 and 20,000,000 pixels; 512x512 has 262,144
  • Wider or taller than 3:1: "size" must not be wider or taller than 3:1
  • Sent with resolution: "size" already fixes the output; do not send "resolution" with it
  • Sent with aspect_ratio: "size" already fixes the output; do not send "aspect_ratio" with it

Example

"size": "2720x1536"

Response

The task object. output is null until the task succeeds. Fields marked “while running” disappear once the task finishes.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error