Images

Create image edit

Changed on

Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models.

post/images/edits

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/images/edits
  • Auth
    HTTP bearer

Request body

EditImageBodyJsonParam required(unresolved $ref)

Response

OK

safety_identifierstring nullable

The effective safety identifier used for safety monitoring and abuse detection. This is the non-empty safety_identifier from the request, or the deprecated user value when safety_identifier is omitted, null, or empty.

createdinteger required

The Unix timestamp (in seconds) of when the image was created.

background'transparent' | 'opaque'

The background parameter used for the image generation. Either transparent or opaque.

output_format'png' | 'webp' | 'jpeg'

The output format of the image generation. Either png, webp, or jpeg.

quality'low' | 'medium' | 'high' | 'xhigh' | 'max'

The quality of the image generated. One of low, medium, high, xhigh, or max.

Changes

  • 761157f39a24Revision changes
    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      request property deprecated (media type: multipart/form-data)

    • info

      request property deprecated (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/event-stream)

    • info

      added the optional property to the response with the status (media type: application/json)

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status