API Reference

Generate with Ideogram 3.0

Generates images synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model.

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

Headers

Api-KeystringRequired

Request

This endpoint expects a multipart form with multiple files.
promptstringRequired

The prompt to use to generate the image.

seedintegerOptional>=0<=2147483647

Random seed. Set for reproducible generation.

resolutionenumOptional

The resolutions supported for Ideogram 3.0.

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.

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_imagesintegerOptional>=1<=8Defaults to 1

Number of images to generate.

color_paletteobjectOptional

A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members). Not supported by V_1, V_1_TURBO, V_2A and V_2A_TURBO models.

style_codeslist of stringsOptional

A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.

style_typeenumOptionalDefaults to GENERAL

The style type to generate with.

Allowed values:
style_reference_imagesfilesOptional

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format.

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