POST
/
images
/
edits
curl https://api.portkey.ai/v1/images/edits \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_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"

{
  "created": 123,
  "data": [
    {
      "b64_json": "<string>",
      "url": "<string>",
      "revised_prompt": "<string>"
    }
  ]
}

Authorizations

​
x-portkey-api-key
string
header
required
​
x-portkey-virtual-key
string
header
required

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.

Example:

"A cute baby sea otter wearing a beret"

​
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.

Example:

"dall-e-2"

​
n
integer | null
default:1

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

Required range: 1 <= x <= 10
Example:

1

​
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
Example:

"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
Example:

"url"

​
user
string

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

Example:

"user-1234"

Response

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

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

Was this page helpful?

Suggest editsRaise issue