video-generate

Generate a video from a first frame with MiniMax H3, by asset id or by uploaded bytes

Generate a video from a first-frame image and a text prompt with MiniMax H3. Supply the first frame either as an image_asset_identifier reference (an image already stored with Ideogram) or as raw image bytes (multipart requests only) — callers are never required to upload the asset first. Exactly one source is required; supplying neither or both is rejected. Only image assets are accepted as a first frame. Uploaded bytes are used for this request only and are not stored as an asset.

To generate a transition between two stills, supply a final frame as well, in either of the same two forms: end_image_asset_identifier or end_image. The final frame is optional and follows the same one-form-only rule.

The generated video takes its aspect ratio from the first frame, so this endpoint accepts no aspect_ratio.

Video generation always runs asynchronously: the response returns as soon as the request is accepted and carries only a generation_id. Poll for completion and results with GET /v1/generations/{generation_id} using that id, or supply a webhook_url to have the finished result POSTed to your server instead.

Video links are available for a limited period of time; download the video if you want to keep it.

post/v2/video/generate/minimax-h3-image-to-video

Query parameters

dry_runboolean

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 body

imagestring binary

The first-frame image to animate (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. The bytes are used for this request only and are not stored as an asset.

end_imagestring binary

An optional final frame (max size 50MB), as raw bytes; only common image formats such as JPEG, PNG, and WEBP are supported. Multipart requests only. When supplied, the generated video transitions from the first frame to this one. The bytes are used for this request only and are not stored as an asset.

promptstring required

A natural-language prompt describing how the first frame should animate.

resolution'480P' | '768P' | '2K' | '4K'

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.

durationinteger

The length of the generated video in seconds.

webhook_urlstring uri

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.

privateboolean nullable

When true or omitted, the output is kept private to your account. Set to false to publish the output to the public feed. Enterprise accounts always generate privately.

target_collection_idstring

A collection you can write to, by its URL-safe base64 collection id. The output video is added to it when the request completes.

Example request

{
  "image_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "end_image_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "prompt": "The camera slowly pans right as the waves roll in.",
  "duration": 5,
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

Response

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

generation_idstring required

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

createdstring date-time required

The time the request was accepted.

Example response

{
  "generation_id": "generation_id",
  "created": "2000-01-23T04:56:07+00:00"
}

Changes

Changed in 5 of the 33 revisions of this API.818

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 4e95197be44a810See the full diff
    • ▲

      removed the enum value 2k of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value 2k of the request property (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value 480p of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value 480p of the request property (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value 4k of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value 4k of the request property (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value 768p of the request property (media type: multipart/form-data)

      request-property-enum-value-removed

    • ▲

      removed the enum value 768p of the request property (media type: application/json)

      request-property-enum-value-removed

    • ○

      the request property default value changed from 2k to 2K (media type: multipart/form-data)

      request-property-default-value-changed

    • ○

      the request property default value changed from 2k to 2K (media type: application/json)

      request-property-default-value-changed

    • ○

      added the new 2K enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new 2K enum value to the request property (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new 480P enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new 480P enum value to the request property (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new 4K enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new 4K enum value to the request property (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new 768P enum value to the request property (media type: multipart/form-data)

      request-property-enum-value-added

    • ○

      added the new 768P enum value to the request property (media type: application/json)

      request-property-enum-value-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the new optional query request parameter dry_run

      new-optional-request-parameter

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      endpoint added

      endpoint-added