---
title: "Edit (legacy)"
method: POST
path: "/edit"
tags: ["generate"]
---

# Edit (legacy)

`POST /edit`

Edit a given image synchronously using the provided mask. The mask indicates which part of the image
should be edited, while the prompt and chosen style type 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.

## Response `200`

Image edits generated successfully.

- GenerateImageResponse — The response which contains information about the generated 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.
  - `request_id` string — URL-safe base64 ID of the sampling request. Present when the caller supplied `webhook_url` and the request was accepted for async delivery; in that case `data` is omitted and the generated images will be POSTed to the customer's `webhook_url` when ready.
  - `created` string, date-time, required — The time the request was created.
  - `data` ImageObject[] — A list of ImageObjects that contain the generated 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 — The resolution of the final image.
    - `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' | 'FICTION' | 'REALISTIC' | 'DESIGN' | 'RENDER_3D' | 'ANIME' | 'CUSTOM' | 'STYLIZED' — The style type to generate with; this is only applicable for models V_2 and above and should not be specified for model versions V_1.

## Other responses

- `400` — Invalid input provided.
- `401` — Not authorized to generate an image.
- `422` — Prompt or Initial Image failed the safety checks.
- `429` — Too many requests.

---

[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/bd40f367a834/schema)