OpenAI · Schema

CreateImageEditRequest

AIArtificial IntelligenceLarge Language ModelsT1

Properties

Name	Type	Description
image	string	The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, the 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 for DALL-E 2 and 32000 characters for gpt-image-1.
mask	string	An additional image whose fully transparent areas indicate where the image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.
model	string	The model to use for image editing.
n	integer	The number of images to generate.
size	string	The size of the generated images.
response_format	string	The format in which the generated images are returned.
user	string	A unique identifier representing your end-user.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateImageEditRequest",
  "type": "object",
  "properties": {
    "image": {
      "type": "string",
      "description": "The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, the image must have transparency which will be used as the mask."
    },
    "prompt": {
      "type": "string",
      "description": "A text description of the desired image(s). The maximum length is 1000 characters for DALL-E 2 and 32000 characters for gpt-image-1."
    },
    "mask": {
      "type": "string",
      "description": "An additional image whose fully transparent areas indicate where the image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image."
    },
    "model": {
      "type": "string",
      "description": "The model to use for image editing."
    },
    "n": {
      "type": "integer",
      "description": "The number of images to generate."
    },
    "size": {
      "type": "string",
      "description": "The size of the generated images."
    },
    "response_format": {
      "type": "string",
      "description": "The format in which the generated images are returned."
    },
    "user": {
      "type": "string",
      "description": "A unique identifier representing your end-user."
    }
  }
}