images-generate

Generate images with a custom Ideogram 4.0 model

Generate one or more images with a custom Ideogram 4.0 model that the authenticated user or organization can access. The model registry controls the model's supported rendering speeds.

The prompt accepts either natural language or a structured Ideogram 4.0 JSON prompt; the server detects which was supplied. A structured JSON prompt is consumed by the model directly and skips magic prompt.

By default the request blocks until the images are ready and returns them in data. Set async to true to return immediately after the request is accepted, then poll for completion and results with GET /v1/generations/{generation_id} using the returned generation_id.

Supplying a webhook_url makes the request asynchronous whatever async says: the response returns as soon as the request is accepted, and the finished result is POSTed to that URL.

post/v2/image/generate/ideogram-4-custom-model

Query parameters

dry_runboolean

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 body

promptstring required

The prompt to generate images from. Accepts either natural language or a structured Ideogram 4.0 JSON prompt; the server detects which was supplied. A structured JSON prompt is consumed by the model directly and skips magic prompt.

custom_model_uristring required

The custom model URI returned by the custom-model API, in the form model/<model_name>/version/<version_name>. The authenticated user or organization must have access to the model.

magic_prompt'auto' | 'on' | 'off'

Determine if MagicPrompt should be used in generating the request or not.

seedinteger

Random seed. Set for reproducible generation.

num_imagesinteger

The number of images to generate.

resolution'2048x2048' | '1440x2880' | '2880x1440' | '1664x2496' | '2496x1664' | '1792x2240' | '2240x1792' | '1440x2560' | '2560x1440' | '1600x2560' | '2560x1600' | '1728x2304' | '2304x1728' | '1296x3168' | '3168x1296' | '1152x2944' | '2944x1152' | '1248x3328' | '3328x1248' | '1280x3072' | '3072x1280' | '1024x3072' | '3072x1024' | '1024x1024' | '896x1120' | '1120x896' | '864x1152' | '1152x864' | '832x1248' | '1248x832' | '800x1280' | '1280x800' | '720x1280' | '1280x720' | '720x1440' | '1440x720' | '512x1536' | '1536x512'

The 1K and 2K resolutions supported for Ideogram 4.0 image generation.

rendering_speed'turbo' | 'default' | 'quality'

The rendering speed to use. When omitted, the server chooses a speed supported by the selected custom model.

enable_copyright_detectionboolean nullable

Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with is_image_safe: false.

asyncboolean

When false (the default), the request blocks 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 /v1/generations/{generation_id} using the returned generation_id.

webhook_urlstring uri

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.

privateboolean nullable

When true or omitted, the output is kept private to your account. Set to false to publish the output to the public feed. Enterprise accounts always generate privately.

target_collection_idstring

A collection you can write to, by its URL-safe base64 collection id. The output images are added to it when the request completes.

Example request

{
  "private": true,
  "seed": 12345,
  "rendering_speed": "turbo",
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "target_collection_id": "target_collection_id",
  "custom_model_uri": "model/my-custom-v4-model/version/1",
  "resolution": "",
  "num_images": 1,
  "magic_prompt": "",
  "async": false,
  "enable_copyright_detection": true,
  "stacked_custom_models": [
    {
      "custom_model_uri": "model/my-base-plora/version/1",
      "weight": 0.5
    }
  ],
  "prompt": "prompt"
}

Response

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

generation_idstring required

URL-safe base64 ID of the accepted generation. Accepted by the GET /v1/generations/{generation_id} polling endpoint.

seedinteger required

Random seed. Set for reproducible generation.

Example response

{
  "data": [
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    }
  ],
  "seed": 12345,
  "generation_id": "generation_id"
}

Changes

Changed in 4 of the 33 revisions of this API.4110

Sep 27, 2026987f73fc82de4See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Sep 23, 2026cdaa218128ba1See the full diff
- ○
  added the new optional request property
  new-optional-request-property
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 19, 20264e95197be44a414See the full diff
- ▲
  added to the request property allOf list
  request-property-all-of-added
- ▲
  removed the enum value DEFAULT of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value QUALITY of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value TURBO of the request property
  request-property-enum-value-removed
- ●
  removed from the request property allOf list
  request-property-all-of-removed
- ○
  the request property default value changed from AUTO to auto
  request-property-default-value-changed
- ○
  added the new default enum value to the request property
  request-property-enum-value-added
- ○
  added the new quality enum value to the request property
  request-property-enum-value-added
- ○
  added the new turbo enum value to the request property
  request-property-enum-value-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 17, 20269d3ff2d98e271See the full diff
- ○
  endpoint added
  endpoint-added

Full history