Creates an edited or extended image given an original image and a prompt.
POST /images/edits
Authorizations
Request Body required
object
The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.
A text description of the desired image(s). The maximum length is 1000 characters.
An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image
should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image
.
The number of images to generate. Must be between 1 and 10.
The size of the generated images. Must be one of 256x256
, 512x512
, or 1024x1024
.
The format in which the generated images are returned. Must be one of url
or b64_json
. URLs are only valid for 60 minutes after the image has been generated.
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
Responses
200
OK
object
Represents the url or the content of an image generated by the OpenAI API.
object
The base64-encoded JSON of the generated image, if response_format
is b64_json
.
The URL of the generated image, if response_format
is url
(default).
The prompt that was used to generate the image, if there was any revision to the prompt.