Skip to navigation
ImagesReframe

Reframe with Ideogram 3.0

Expand an image to a new Ideogram 3.0 resolution, keeping the source pixels in the center and filling the new area. Upload the source image using multipart/form-data. Returns results directly by default; set async to get a generation_id and poll GET /v2/generations/{generation_id}.

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

Use multipart/form-data to upload the source image and any style_reference_images.

imagefileRequired

The JPEG, PNG, or WEBP image to reframe (max 25MB). Multipart requests only.

resolutionenumRequired
The resolutions supported for Ideogram 3.0.
num_imagesintegerOptional1-8Defaults to 1
The number of images to generate.
seedintegerOptional0-2147483647
Random seed. Set for reproducible generation.
rendering_speedenumOptionalDefaults to default
Allowed values:
style_presetenumOptional
A predefined style preset that applies a specific artistic style to the generated image.
color_paletteobjectOptional

A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members).

style_codeslist of stringsOptional

A list of 8-character hexadecimal codes representing the style of the image. Refer to each endpoint for supported combinations with style types, presets, and reference images.

style_reference_imagesfilesOptional

JPEG, PNG, or WEBP style reference images (max 10, max 25MB each). Multipart requests only. Cannot be combined with style_preset or style_codes.

asyncbooleanOptionalDefaults to false
Return immediately instead of waiting for reframed images.

Response

The reframed images, or an acknowledgement for an asynchronous request.
generation_idstring

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

seedinteger0-2147483647
Random seed. Set for reproducible generation.
datalist of objectsOptional

The reframed images, in generation order. Present only for synchronous requests (async omitted or false).

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error