Create Image Edit

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

POSThttps://api.portkey.ai/v1/images/edits

Body

multipart/form-data

image*string (binary)

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.

Example: "A cute baby sea otter wearing a beret"

maskstring (binary)

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.

modelnullable any of

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

Example: "dall-e-2"

stringenum

nnullable integer

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

Example: 1

sizenullable enum

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

Example: "1024x1024"

256x256512x5121024x1024

response_formatnullable enum

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.

Example: "url"

urlb64_json

userstring

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

Example: "user-1234"

Response

200

OK

Body

application/json

created*integer

data*array of Image (object)

Response

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