Generate a consistent character with Ideogram 3.0
Generate images featuring a consistent character with Ideogram 3.0.
Upload the character as character_reference_images 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
A request to generate images of a consistent character with Ideogram 3.0. Send it as multipart/form-data to upload character_reference_images and any style_reference_images.
An image of the character to feature (max 25MB; JPEG, PNG, or WEBP).
Optional grayscale mask marking where the character is in the character_reference_images image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only.
The aspect ratio for an Ideogram 3.x or 2.x generation. auto lets the
model select a ratio from the prompt; any other value pins the ratio.
Cannot be combined with resolution. Omitting the field is not auto:
it uses 1x1.
Controls magic prompt (automatic prompt rewriting). Defaults to auto.
The style type to generate the character with. Defaults to auto.
Images to use as style references (max 10, max 25MB each; JPEG, PNG, or WEBP).
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).