---
title: "Edit images with a prompt"
method: POST
path: "/v1/edit"
tags: ["generate"]
---

# Edit images with a prompt

`POST /v1/edit`

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.

## Response `200`

Image edits generated successfully.

- V1EditImagesResponse — The response which contains information about the edited image, including the download link. Images links are available for a limited period of time; if you would like to keep the image, you must download it.
  - `created` string, date-time, required — The time the request was created.
  - `data` V1EditImageObject[], required — A list of ImageObjects that contain the edited image(s).
    - `url` string, uri, nullable — The direct link to the image generated.
    - `prompt` string, required — The prompt used for the generation. This may be different from the original prompt.
    - `resolution` string, required — Output resolution, only used if operations alters image dimensions, such as upscale, crop etc.
    - `upscaled_resolution` string — Output resolution, only used if operations alters image dimensions, such as upscale, crop etc.
    - `is_image_safe` boolean, required — Whether this request passes safety checks. If false, the url field will be empty.
    - `seed` integer, required — Random seed. Set for reproducible generation.
    - `style_type` 'AUTO' | 'GENERAL' | 'REALISTIC' | 'DESIGN' | 'CUSTOM' | 'FICTION' | 'STYLIZED' — The style type to generate with.

## Other responses

- `400` — Invalid input provided.
- `401` — Not authorized to generate an image.
- `402` — Insufficient credits or quota.
- `422` — Prompt or provided image failed safety checks.
- `429` — Too many requests.
- `503` — Image generation service temporarily unavailable.

---

[API](https://skmtc.net/ideogram/apis/ideogram-openapi-3-0.md) · [All operations](https://skmtc.net/ideogram/apis/ideogram-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideogram/ideogram-openapi-3-0/revisions/b560c0ad0618/schema)