Remix with Ideogram 4.0
Transform an existing image with Ideogram 4.0, guided by a text
prompt. Upload the source image using multipart/form-data.
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 key for access control. Use in the header with the name "Api-Key"
Query parameters
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.
The prompt that guides the remix. It is always read as an editing instruction, so there is no magic_prompt option.
The image to transform (max 50MB). JPEG, PNG, and WEBP are supported. Multipart requests only. The uploaded image is saved to your account as the remix's source. Omit resolution to keep its shape.
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 resolution whose aspect ratio differs from the source's is rejected with a 400.
Optional. When supplied, the images are generated at this
resolution. When omitted, the source image's shape is kept. A
resolution whose aspect ratio differs from the source's cannot
be combined with image_weight.
Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with is_image_safe: 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.
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).
URL-safe base64 ID of the accepted generation. Accepted by the
GET /v2/generations/{generation_id} polling endpoint.
The remixed images, in generation order. Present only for synchronous requests (async omitted or false).