Skip to navigation

Remix with Ideogram 4.5

Transform an existing image with Ideogram 4.5, guided by a text prompt. Supply one source image to transform and, optionally, up to four reference images to bring into the result (for example a product, a logo, or a style). Upload images using multipart/form-data, or pass existing assets by reference. Returns results directly by default; set async or supply a webhook_url 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

A request to remix an image with Ideogram 4.5. Use multipart/form-data to upload the source image or reference_images.

promptstringRequired1-10000 characters

The prompt that guides the remix. It is always read as an editing instruction, so there is no magic_prompt option.

image_asset_identifierobjectOptional

The existing upload or generated image to transform. Supply this or image, never both. Leave size as “source” to keep its shape.

imagefileOptional

The image to transform. JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix’s source. Supply this or image_asset_identifier, never both. Leave size as “source” to keep its shape.

reference_image_asset_identifierslist of objectsOptional

Optional existing upload or generated images to bring into the result, such as a product, a logo, or a style. They guide the remix but are not transformed themselves. Supply this or reference_images, never both.

reference_imagesfilesOptional

Optional reference images to upload (max 4; JPEG, PNG, or WEBP). The same rules as reference_image_asset_identifiers apply. Multipart requests only.

image_weightintegerOptional1-100

Optional. How closely the result should follow the source image, from 1 to 100. When omitted the server chooses a value from your prompt, which is the usual case. Only accepted when the output keeps the source image’s shape: combining image_weight with a size whose aspect ratio differs from the source’s is rejected with a 400.

num_imagesintegerOptional1-8Defaults to 1
The number of images to generate.
sizestring or nullOptionalDefaults to source

The output size: “source” or an exact “WIDTHxHEIGHT”.

“source” (the default) keeps the source image’s shape at the closest supported Ideogram 4.5 size. An exact size must be a supported Ideogram 4.5 size (for example 2048x2048 or 1440x2560), and one whose aspect ratio differs from the source’s cannot be combined with image_weight.

qualityenumOptionalDefaults to high
The rendering quality to use. Higher quality takes longer and costs more.
Allowed values:
asyncbooleanOptionalDefaults to false

When false (the default), the request waits until the images are ready and returns them in data. When true, the request returns as soon as it is accepted; poll for completion and results with GET /v2/generations/{generation_id} using the returned generation_id.

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

The remixed images (synchronous requests), or an acknowledgement to poll with GET /v2/generations/{generation_id} (async requests).

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 remixed 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
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error