generate

Edit (legacy)

Changed on

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.

post/edit

Request

  • Base URL: https://api.ideogram.ai
  • URL: https://api.ideogram.ai/edit
  • Auth: API key in header Api-Key

Response

Image edits generated successfully.

request_idstring

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.

createdstring date-time required

The time the request was created.

Changes

  • de120c38c7a2Revision changes
    • warning

      deleted the header request parameter Api-Key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

  • 3125bb1c38a6Revision changes
    • info

      api operation id post_edit_image removed and replaced with generate_post_edit_image