Generate with Ideogram 3.0 (Transparent Background) | Ideogram

Generates images with transparent background synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model. Images will be generated using maximum supported resolution at the specified aspect ratio to allow best results with upscaler. The selected resolution is written to the response, not the upscaled final resolution.

rendering_speed=FLASH is not supported for transparent-background generation; the request will return a 400. Use TURBO, DEFAULT, or QUALITY instead.

Images links are available for a limited period of time; if you would like to keep the image, you must download it.

Authentication

Api-Keystring

API key for access control. Use in the header with the name "Api-Key"

Request

A request to generate an image with transparent background using Ideogram 3.0, with optional upscaling.

promptstringRequired

The prompt to use to generate the image.

seedintegerOptional0-2147483647

Random seed. Set for reproducible generation.

upscale_factorenumOptionalDefaults to X1

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

Allowed values:

aspect_ratioenumOptional

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_speedenumOptionalDefaults to DEFAULT

The rendering speed to use. FLASH is not supported for transparent-background generation; requests with rendering_speed=FLASH will return a 400.

Allowed values:

magic_promptenumOptional

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

Allowed values:

negative_promptstringOptional

Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt.

num_imagesintegerOptional1-8Defaults to 1

Number of images to generate.

enable_copyright_detectionboolean or nullOptional

Optional. Opt this request into post-generation copyright detection (Hive likeness + logo checks). The effective gate is the OR of this field and the organization's copyright_detection_enabled setting on /api: if the org has it on, this is ignored; if the org has it off, setting this true enables detection for this request only. Adds detection latency. Flagged images come back with is_image_safe: false.

Response

Image(s) generated successfully.

createddatetime

The time the request was created.

datalist of objects

A list of ImageObjects that contain the generated image(s).

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error