API Reference

Edit images with a prompt

Edit one or more images using a text prompt. Provide images via file upload or Ideogram image URLs, and describe the desired edit in your prompt.

Supported image formats include JPEG, PNG, and WebP.

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 edit images.
promptstringRequired
The prompt describing the desired edit.
imagesfilesOptional

Images to edit (max 10 images, max size 10MB each); JPEG, WebP and PNG formats are supported.

image_urlslist of stringsOptional

URLs to Ideogram images to use as references (max 10). Supports URLs from generation responses and image uploads. Alternative to uploading via the images field.

num_imagesintegerOptional1-8Defaults to 1
The number of images to generate.
seedintegerOptional0-2147483647
Random seed. Set for reproducible generation.
magic_promptenumOptional
Determine if MagicPrompt should be used in generating the request or not.
Allowed values:
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.
transparent_backgroundbooleanOptionalDefaults to false
Whether the output should have a transparent background. Default false.

Response

Image edits generated successfully.
createddatetime
The time the request was created.
datalist of objects

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

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error