Generate transparent-background images with Ideogram 3.0

Generate one or more images on a transparent background with Ideogram 3.0, delivered as PNGs with alpha. An optional upscale_factor increases the output size after generation.

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.

Request body

promptstring required

The prompt to generate images from.

negative_promptstring

Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt.

seedinteger

Random seed. Set for reproducible generation.

upscale_factor'X1' | 'X2' | 'X4'

Upscale the initially generated image by the given factor. Upscale factors other than X1 will incur additional cost.

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.

rendering_speed'FLASH' | 'TURBO' | 'BALANCED' | 'DEFAULT' | 'QUALITY'

The rendering speed to use.

magic_prompt'AUTO' | 'ON' | 'OFF'

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

num_imagesinteger

The number of images to generate.

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.

Example request

{
  "magic_prompt": "",
  "aspect_ratio": null,
  "async": false,
  "seed": 12345,
  "upscale_factor": "X2",
  "rendering_speed": "",
  "negative_prompt": "negative_prompt",
  "enable_copyright_detection": true,
  "prompt": "prompt",
  "num_images": 1
}

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