Create image edit

POSThttps://api.openai.com/v1/images/edits

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

Request

Header Params

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params multipart/form-data

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.

Example:

cmMtdXBsb2FkLTE2ODc4MzMzNDc3NTEtMjA=/31225951_59371037e9_small.png

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.

Example:

[]

prompt

string

required

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

Example:

A cute baby sea otter wearing a beret.

string

optional

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

Example:

size

string

optional

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

Example:

1024x1024

response_format

string

optional

The format in which the generated images are returned. Must be one of url or b64_json.

Example:

url

user

string

optional

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

Request samples

Responses

成功(200)

HTTP Code: 200

Content Type : JSONapplication/json

created

integer

required

data

array [object {1}]

required

url

string

required

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

Last modified: a year ago