OpenAI API | Images › Create Image Edit

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

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

mask?: string

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 |

ImageModel

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

n?: number

The number of images to generate. Must be between 1 and 10.

response_format?: "url" | "b64_json"

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.

size?: "256x256" | "512x512" | "1024x1024"

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

user?: string

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

Response fields

ImagesResponse

Request example

curl https://api.openai.com/v1/images/edits \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -F image=file.txt \
    -F prompt='A cute baby sea otter wearing a beret' \
    -F model=dall-e-2 \
    -F n=1 \
    -F response_format=url \
    -F size=256x256 \
    -F user=user-1234

200Example

{
  "created": 0,
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "url"
    }
  ]
}

Create Image ->

ImagesResponse

post/images/generations

Creates an image given a prompt.

Domain types

Image = { b64_json, revised_prompt, url }

ImageModel = "dall-e-2" | "dall-e-3"

ImagesResponse = { created, data }