Sign in
video-generate

Generate a video from a text prompt with MiniMax H3

Generate a video from a text prompt with MiniMax H3.

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-text-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

promptstring required

A natural-language prompt describing the video to generate.

aspect_ratio'21x9' | '16x9' | '4x3' | '1x1' | '3x4' | '9x16'

The aspect ratio of the generated video.

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

{
  "duration": 5,
  "aspect_ratio": null,
  "private": true,
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "target_collection_id": "target_collection_id",
  "prompt": "A red fox running through a snowy forest at dawn.",
  "resolution": null
}

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.413

  • 987f73fc82de4See the full diff
    • ○

      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

  • 4e95197be44a45See the full diff
    • ▲

      removed the enum value 2k of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value 480p of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value 4k of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value 768p of the request property

      request-property-enum-value-removed

    • ○

      the request property default value changed from 2k to 2K

      request-property-default-value-changed

    • ○

      added the new 2K enum value to the request property

      request-property-enum-value-added

    • ○

      added the new 480P enum value to the request property

      request-property-enum-value-added

    • ○

      added the new 4K enum value to the request property

      request-property-enum-value-added

    • ○

      added the new 768P enum value to the request property

      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

  • a235a15c02351See the full diff
    • ○

      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

  • 1429d75daa362See the full diff
    • ○

      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

  • 583d867895481See the full diff
    • ○

      endpoint added

      endpoint-added