Generate transparent images with Ideogram 4.0
Generate images on a transparent background with Ideogram 4.0, delivered
as PNGs with alpha. 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
A request to generate transparent-background images with Ideogram 4.0.
Controls how a natural-language prompt is prepared. auto (the
default) and on rewrite and expand the prompt before generation.
off keeps your wording and only converts it into a structured
prompt. A valid structured JSON prompt skips magic prompt unless
magic_prompt is on.
The aspect ratio for an Ideogram 4.0 magic prompt. auto lets the
model select the most suitable ratio from the prompt; any other value
pins the ratio. The non-auto values are the buckets the 4.0 model
supports.
The output resolution tier. Each tier is a total pixel budget equal
to a square of the named size (for example, 8k delivers at most
8192x8192 pixels in total). Wide and tall aspect ratios keep the
same budget, so one side may exceed the named size. Tiers above
2k are produced by upscaling after generation. Defaults to 1k.
Optional. Run copyright detection on the generated images. Adds latency; flagged images are returned 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 GET /v2/generations/{generation_id} with the returned generation_id for the result.
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 generated images (synchronous requests), or an acknowledgement to poll with GET /v2/generations/{generation_id} (async requests).
URL-safe base64 ID of the generation. Use it to poll
GET /v2/generations/{generation_id}.
The generated images, in generation order. Present only for synchronous requests (async omitted or false).