Skip to navigation

Text to video with MiniMax H3

Generate a video from a text prompt with MiniMax H3. Returns a generation_id; poll GET /v2/generations/{generation_id} or supply a webhook_url.

Authentication

Api-Keystring

API key for access control. Use in the header with the name "Api-Key"

Query parameters

dry_runbooleanOptionalDefaults to false

When true, the request is validated and priced but not run: nothing is generated, stored, or billed, and no safety review is performed. The response is a PriceQuote object instead of the usual response for this endpoint. Send exactly the request you would send to generate, so the quote reflects the same options.

Request

A request to generate a video from a text prompt with MiniMax H3.
promptstringRequired1-2000 characters

A natural-language prompt describing the video to generate.

aspect_ratioenumOptionalDefaults to 16x9
The aspect ratio of the generated video.
resolutionenumOptionalDefaults to 2K

The resolution tier of the generated video, spelled the way MiniMax spells it. 480P and 768P are generated natively; 2K and 4K are upscaled from a 768P result. Higher tiers cost more.

Allowed values:
durationintegerOptional5-15Defaults to 5
The length of the generated video in seconds.
webhook_urlstringOptionalformat: "uri"<=2048 characters

HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: request_id, created, and a data array containing every generated image (url, prompt, resolution, seed, is_image_safe). Each delivery is signed with Ed25519 and verifiable against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

Response

An acknowledgement to poll with GET /v2/generations/{generation_id}.

generation_idstring

URL-safe base64 ID of the accepted generation. Accepted by the GET /v2/generations/{generation_id} polling endpoint.

createddatetime
The time the request was accepted.

Errors

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