Edit with Ideogram 3.0

POST

/ideogram/v1/ideogram-v3/edit

Edit a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image should be edited, while the prompt and chosen style can further guide the edit.
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.
More details: https://developer.ideogram.ai/api-reference/api-reference/edit-v3

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/ideogram/v1/ideogram-v3/edit' \
--header 'Content-Type: multipart/form-data' \
--form 'image=@""' \
--form 'mask=@""' \
--form 'prompt=""' \
--form 'seed="";type=false' \
--form 'resolution=""' \
--form 'rendering_speed=""' \
--form 'magic_prompt=""' \
--form 'num_images=""' \
--form 'color_palette=""' \
--form 'style_codes=""' \
--form 'style_type=""' \
--form 'style_reference_images=""'

Responses

🟢200Successful

application/json

Body

Example

curl -X POST https://api.yescale.io/ideogram/v1/ideogram-v3/edit \
  -H "Api-Key: <apiKey>" \
  -H "Content-Type: multipart/form-data" \
  -F image=@<file1> \
  -F mask=@<file1> \
  -F prompt="A photo of a cat wearing a hat." \
  -F rendering_speed="DEFAULT"

Modified at 2025-05-22 02:48:31

Generate with Ideogram 3.0

Remix with Ideogram 3.0