POST
/
images
/
edits

Authorizations

​
x-portkey-api-key
string
headerrequired
​
x-portkey-virtual-key
string
headerrequired

Body

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.

​
prompt
string
required

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

​
mask
file

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
default: dall-e-2

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

​
n
integer | null
default: 1

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

Required range: 1 < x < 10
​
size
enum<string> | null
default: 1024x1024

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

Available options:
256x256,
512x512,
1024x1024
​
response_format
enum<string> | null
default: 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.

Available options:
url,
b64_json
​
user
string

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

Response

200 - application/json
​
created
integer
required
​
data
object[]
required

Was this page helpful?

Create ImageCreate Image Variation