Constructor Detail

Method Detail

• image

   final ImageEditParams.Image image()

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

  For the GPT image models (gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, and chatgpt-image-latest), each image should be a png, webp, or jpg file less than 50MB. 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.

• prompt

   final String prompt()

  A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2, and 32000 characters for the GPT image models.

• background

   final Optional<ImageEditParams.Background> background()

  Allows to set transparency for the background of the generated image(s). This parameter is only supported for GPT image models that support transparent backgrounds. Must be one of transparent, opaque, or auto (default value). When auto is used, the model will automatically determine the best background for the image.

  gpt-image-2 and gpt-image-2-2026-04-21 do not support transparent backgrounds. Requests with background set to transparent will return an error for these models; use opaque or auto instead.

  If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

• inputFidelity

   final Optional<ImageEditParams.InputFidelity> inputFidelity()

  Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

• mask

   final Optional<InputStream> mask()

  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

   final Optional<ImageModel> model()

  The model to use for image generation. One of dall-e-2 or a GPT image model (gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, or chatgpt-image-latest). Defaults to gpt-image-1.5.

• n

   final Optional<Long> n()

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

• outputCompression

   final Optional<Long> outputCompression()

  The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the webp or jpeg output formats, and defaults to 100.

• outputFormat

   final Optional<ImageEditParams.OutputFormat> outputFormat()

  The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp. The default value is png.

• partialImages

   final Optional<Long> partialImages()

  The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.

  Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.

• quality

   final Optional<ImageEditParams.Quality> quality()

  The quality of the image that will be generated for GPT image models. Defaults to auto.

• responseFormat

   final Optional<ImageEditParams.ResponseFormat> responseFormat()

  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 (default is url for dall-e-2), as GPT image models always return base64-encoded images.

• size

   final Optional<ImageEditParams.Size> size()

  The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

• user

   final Optional<String> user()

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

• _image

   final MultipartField<ImageEditParams.Image> _image()

  Returns the raw multipart value of image.

  Unlike image, this method doesn't throw if the multipart field has an unexpected type.

• _prompt

   final MultipartField<String> _prompt()

  Returns the raw multipart value of prompt.

  Unlike prompt, this method doesn't throw if the multipart field has an unexpected type.

• _background

   final MultipartField<ImageEditParams.Background> _background()

  Returns the raw multipart value of background.

  Unlike background, this method doesn't throw if the multipart field has an unexpected type.

• _inputFidelity

   final MultipartField<ImageEditParams.InputFidelity> _inputFidelity()

  Returns the raw multipart value of inputFidelity.

  Unlike inputFidelity, this method doesn't throw if the multipart field has an unexpected type.

• _mask

   final MultipartField<InputStream> _mask()

  Returns the raw multipart value of mask.

  Unlike mask, this method doesn't throw if the multipart field has an unexpected type.

• _model

   final MultipartField<ImageModel> _model()

  Returns the raw multipart value of model.

  Unlike model, this method doesn't throw if the multipart field has an unexpected type.

• _n

   final MultipartField<Long> _n()

  Returns the raw multipart value of n.

  Unlike n, this method doesn't throw if the multipart field has an unexpected type.

• _outputCompression

   final MultipartField<Long> _outputCompression()

  Returns the raw multipart value of outputCompression.

  Unlike outputCompression, this method doesn't throw if the multipart field has an unexpected type.

• _outputFormat

   final MultipartField<ImageEditParams.OutputFormat> _outputFormat()

  Returns the raw multipart value of outputFormat.

  Unlike outputFormat, this method doesn't throw if the multipart field has an unexpected type.

• _partialImages

   final MultipartField<Long> _partialImages()

  Returns the raw multipart value of partialImages.

  Unlike partialImages, this method doesn't throw if the multipart field has an unexpected type.

• _quality

   final MultipartField<ImageEditParams.Quality> _quality()

  Returns the raw multipart value of quality.

  Unlike quality, this method doesn't throw if the multipart field has an unexpected type.

• _responseFormat

   final MultipartField<ImageEditParams.ResponseFormat> _responseFormat()

  Returns the raw multipart value of responseFormat.

  Unlike responseFormat, this method doesn't throw if the multipart field has an unexpected type.

• _size

   final MultipartField<ImageEditParams.Size> _size()

  Returns the raw multipart value of size.

  Unlike size, this method doesn't throw if the multipart field has an unexpected type.

• _user

   final MultipartField<String> _user()

  Returns the raw multipart value of user.

  Unlike user, this method doesn't throw if the multipart field has an unexpected type.

• _additionalBodyProperties

   final Map<String, JsonValue> _additionalBodyProperties()

• _additionalHeaders

   final Headers _additionalHeaders()

  Additional headers to send with the request.

• _additionalQueryParams

   final QueryParams _additionalQueryParams()

  Additional query param to send with the request.

• toBuilder

   final ImageEditParams.Builder toBuilder()

• _body

   final Map<String, MultipartField<?>> _body()

• _headers

   Headers _headers()

  The full set of headers in the parameters, including both fixed and additional headers.

• _queryParams

   QueryParams _queryParams()

  The full set of query params in the parameters, including both fixed and additional query params.

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static ImageEditParams.Builder builder()

  Returns a mutable builder for constructing an instance of ImageEditParams.

  The following fields are required:

  .image()
  .prompt()