Create image edit

POST https://api.fastapi.ai/v1/images/edits

Creates an edited or extended image given an original image and a prompt.

Request body

---

image file Required
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.

---

prompt string Required
A text description of the desired image(s). The maximum length is 1000 characters.

---

mask file Optional
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.

---

model string Optional Defaults to dall-e-2
The model to use for image generation. Only dall-e-2 is supported at this time.

---

n integer or null Optional Defaults to 1
The number of images to generate. Must be between 1 and 10.

---

size string or null Optional Defaults to 1024x1024
The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

---

response_format string or null Optional Defaults to url
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.

---

user string Optional
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

---

Returns a list of image objects.

---

The image object

Represents the url or the content of an image generated by the OpenAI API.

---

b64_json string
The base64-encoded JSON of the generated image, if response_format is b64_json.

---

url string
The URL of the generated image, if response_format is url (default).

---

revised_prompt string
The prompt that was used to generate the image, if there was any revision to the prompt.

---

OBJECT The image object

{
  "url": "...",
  "revised_prompt": "..."
}

Example

Request

curl https://api.fastapi.ai/v1/images/edits \
  -H "Authorization: Bearer $FAST_API_KEY" \
  -F image="@otter.png" \
  -F mask="@mask.png" \
  -F prompt="A cute baby sea otter wearing a beret" \
  -F n=2 \
  -F size="1024x1024"

Response

{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}