images-generate

Generate images with P-Image Ideogram from a text or structured prompt

Generate one or more images with P-Image Ideogram, a fast model with selectable quality and resolution tiers. The prompt accepts either natural language or a structured Ideogram 4.0 JSON prompt; the server detects which was supplied.

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/images/generate/p-image-ideogram

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.

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.

quality'VERY_LOW' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH'

The generation quality level. Higher levels may use more inference steps or additional prompt processing.

resolution'1K' | '2K' nullable

The output-size tier; the server defaults to 1K when omitted. Cannot be combined with custom_width/custom_height.

aspect_ratio'1x3' | '3x1' | '1x2' | '2x1' | '9x16' | '16x9' | '10x16' | '16x10' | '2x3' | '3x2' | '3x4' | '4x3' | '4x5' | '5x4' | '1x1'

The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1x1.

custom_widthinteger nullable

Optional. An exact output width in pixels, used together with custom_height for output sizes outside the preset tiers. Must be a positive multiple of 16 between 16 and 4096, and custom_width × custom_height must not exceed 4,194,304 pixels (2048×2048). Cannot be combined with resolution or aspect_ratio; the request is billed at the resolution tier matching its total pixel count.

custom_heightinteger nullable

Optional. An exact output height in pixels, used together with custom_width. See custom_width for the accepted range and billing behavior.

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

{
  "aspect_ratio": "",
  "custom_height": 1,
  "private": true,
  "seed": 12345,
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "custom_width": 6,
  "target_collection_id": "target_collection_id",
  "resolution": "1K",
  "num_images": 1,
  "quality": "",
  "magic_prompt": "",
  "async": false,
  "enable_copyright_detection": true,
  "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