Skip to navigation
ImagesGenerate

Generate with a custom Ideogram 4.0 model

Generate images with a custom Ideogram 4.0 model that you or your organization can access, selected by custom_model_uri. 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 generate images with an accessible custom Ideogram 4.0 model.
promptstringRequired1-10000 characters
The prompt to generate images from, in natural language or as a structured Ideogram 4.0 JSON prompt. A structured JSON prompt is used as is and skips magic prompt.
custom_model_uristringRequiredformat: "^model/[^/]+/version/[^/]+$"1-512 characters

The custom model URI, in the form model/<model_name>/version/<version_name>. You or your organization must have access to the model. The model determines which rendering speeds are supported.

magic_promptenumOptionalDefaults to auto

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.

Allowed values:
seedintegerOptional0-2147483647
Random seed. Set for reproducible generation.
num_imagesintegerOptional1-8Defaults to 1
The number of images to generate.
resolutionenumOptional
Optional. When supplied, the images are generated at this resolution. When omitted, an aspect ratio is picked automatically based on the prompt.
rendering_speedenumOptional
The rendering speed to use. When omitted, a speed supported by the custom model is used.
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 GET /v2/generations/{generation_id} with the returned generation_id for the result.

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 generated images (synchronous requests), or an acknowledgement to poll with GET /v2/generations/{generation_id} (async requests).

generation_idstring

URL-safe base64 ID of the generation. Use it to poll GET /v2/generations/{generation_id}.

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

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