Sign in
images-reframe

Reframe an image, letting Ideogram pick the model

Changed on

Reframe one image to a new aspect ratio without choosing a model. Ideogram selects the model best suited to the source and may route different requests to different models; the request is billed at the chosen model's price. Supply either an existing Ideogram image asset or raw image bytes, but not both.

This operation is asynchronous. It returns as soon as the request is accepted; poll GET /v2/generations/{generation_id} for completion and results.

post/v2/image/reframe/auto

Request

  • Base URL: (relative, and it does not resolve against the document’s source URL)
  • URL: /v2/image/reframe/auto
  • Auth: one of:
    • API key in header Api-Key
    • HTTP bearer

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 JPEG, PNG, or WEBP image to reframe (max 50MB).

aspect_ratiostring required

The requested output aspect ratio, as width:height.

privateboolean

API-key requests are always private. For bearer-authenticated requests, this controls whether the result is private; when omitted, it follows the caller's plan entitlement. Enterprise generations are always private.

num_imagesinteger

The number of output images to generate.

seedinteger

Random seed. Set for reproducible generation.

Example request

{
  "image_asset_identifier": {
    "asset_type": "RESPONSE",
    "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
  },
  "aspect_ratio": "16:9",
  "seed": 12345
}

Response

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

generation_idstring required

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

seedinteger required

Random seed. Set for reproducible generation.

widthinteger required

The resolved output width in pixels.

heightinteger required

The resolved output height in pixels.

Example response

{
  "seed": 12345,
  "generation_id": "generation_id",
  "width": 0,
  "height": 6
}

Changes

  • 919a744eb885Revision changes
    • ○

      added the new optional request property / (media type: multipart/form-data)

    • ○

      added the new optional request property / (media type: application/json)

  • e65475352df1Revision changes
    • ○

      endpoint added