Create Image Edit

post

Authorizations

Body

imagestring · binaryRequired

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.

promptstringRequired

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

Example: A cute baby sea otter wearing a beret

maskstring · binaryOptional

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.

modelany of | nullableOptional

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

Default: dall-e-2Example: dall-e-2

stringOptional

string · enumOptionalPossible values:

ninteger | nullableOptional

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

Default: 1Example: 1

sizestring · enum | nullableOptional

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

Default: 1024x1024Example: 1024x1024Possible values:

response_formatstring · enum | nullableOptional

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.

Default: urlExample: urlPossible values:

userstringOptional

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

Example: user-1234

Responses

200

application/json

post

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"

200

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