Create image edit

POSThttps:/api.openai.com/v1/images/edits

Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.

Request body

  • image
    string or array

    The image(s) to edit. Must be a supported image file or an array of images.

    For gpt-image-1, each image should be a png, webp, or jpg file less than 25MB. You can provide up to 16 images.

    For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

    • image
      string
      Required
    • image
      array
      Required
      • items
        string
  • prompt
    string
    Required

    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 (e.g. where alpha is zero) indicate where image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

  • model
    string

    The model to use for image generation. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

    • model
      string
    • model
      string
      • dall-e-2
        string
      • gpt-image-1
        string
  • n
    integer or null
    Defaults: 1
    The number of images to generate. Must be between 1 and 10.
  • size
    string or null
    Defaults: 1024x1024

    The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for gpt-image-1, and one of 256x256, 512x512, or 1024x1024 for dall-e-2.

    • 256x256
      string
    • 512x512
      string
    • 1024x1024
      string
    • 1536x1024
      string
    • 1024x1536
      string
    • auto
      string
  • response_format
    string or null
    Defaults: 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. This parameter is only supported for dall-e-2, as gpt-image-1 will always return base64-encoded images.

    • url
      string
    • b64_json
      string
  • user
    string

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

  • quality
    string or null
    Defaults: auto

    The quality of the image that will be generated. high, medium and low are only supported for gpt-image-1. dall-e-2 only supports standard quality. Defaults to auto.

    • standard
      string
    • low
      string
    • medium
      string
    • high
      string
    • auto
      string

Response

Returns a list of image objects.

Example request
1
curl -s -D >(grep -i x-request-id >&2) \

2
  -o >(jq -r '.data[0].b64_json' | base64 --decode > gift-basket.png) \

3
  -X POST "https://api.openai.com/v1/images/edits" \

4
  -H "Authorization: Bearer $OPENAI_API_KEY" \

5
  -F "model=gpt-image-1" \

6
  -F "image[]=@body-lotion.png" \

7
  -F "image[]=@bath-bomb.png" \

8
  -F "image[]=@incense-kit.png" \

9
  -F "image[]=@soap.png" \

10
  -F 'prompt=Create a lovely gift basket with these four items in it'
Example response
1
{

2
  "created": 1713833628,

3
  "data": [

4
    {

5
      "b64_json": "..."

6
    }

7
  ],

8
  "usage": {

9
    "total_tokens": 100,

10
    "input_tokens": 50,

11
    "output_tokens": 50,

12
    "input_tokens_details": {

13
      "text_tokens": 10,

14
      "image_tokens": 40

15
    }

16
  }

17
}
Built with