Struct CreateImageEditRequestArgs 

pub struct CreateImageEditRequestArgs { /* private fields */ }

Available on crate feature image-types only.

Builder for CreateImageEditRequest.

Implementations

impl CreateImageEditRequestArgs

pub fn image<VALUE: Into<ImageEditInput>>(&mut self, value: VALUE) -> &mut Self

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

For the GPT image models (gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08), each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images. chatgpt-image-latest follows the same input constraints as GPT image models.

pub fn prompt<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models.

pub fn mask<VALUE: Into<ImageInput>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn background<VALUE: Into<ImageBackground>>( &mut self, value: VALUE, ) -> &mut Self

Set the background of the generated image(s). This parameter is only supported for the GPT image models. 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.

Transparent backgrounds are available for supported GPT Image models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in preview. When using transparent, set the output format to png or webp.

pub fn model<VALUE: Into<ImageModel>>(&mut self, value: VALUE) -> &mut Self

The GPT image model to use for image editing (gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, gpt-image-2.5-flare-2026-09-08, or chatgpt-image-latest).

gpt-image-1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.

pub fn n<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

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

pub fn size<VALUE: Into<ImageSize>>(&mut self, value: VALUE) -> &mut Self

The size of the generated images. Defaults to auto. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, 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.

pub fn response_format<VALUE: Into<ImageResponseFormat>>( &mut self, value: VALUE, ) -> &mut Self

Legacy response format parameter for retired image models. Unsupported for GPT image models, which always return base64-encoded images.

pub fn output_format<VALUE: Into<ImageOutputFormat>>( &mut self, value: VALUE, ) -> &mut Self

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.

pub fn output_compression<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn user<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Deprecated: use safety_identifier instead. This parameter remains accepted for backward compatibility and is used when safety_identifier is omitted, null, or empty. Learn more.

pub fn input_fidelity<VALUE: Into<InputFidelity>>( &mut self, value: VALUE, ) -> &mut Self

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 the GPT image models. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

pub fn stream<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Edit the image in streaming mode. Defaults to false. See the Image generation guide for more information.

pub fn partial_images<VALUE: Into<u8>>(&mut self, value: VALUE) -> &mut Self

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.

pub fn quality<VALUE: Into<ImageQuality>>(&mut self, value: VALUE) -> &mut Self

The quality of the image that will be generated. GPT image models support quality levels through max; dall-e-2 supports standard. Defaults to auto.

pub fn safety_identifier<VALUE: Into<String>>( &mut self, value: VALUE, ) -> &mut Self

A stable identifier for an end user in your organization, used for safety monitoring and abuse detection. Hash a username or email address to avoid sending identifying information. A non-empty value takes precedence over the deprecated user parameter. If omitted, null, or empty, the API uses user when available. Learn more.

pub fn markup<VALUE: Into<ImageInput>>(&mut self, value: VALUE) -> &mut Self

A transparent PNG overlaid on the first image to guide the edit. Must match that image’s dimensions after orientation and contain transparent pixels. Supports GPT Image 2.5. Cannot be combined with mask.

pub fn build(&self) -> Result<CreateImageEditRequest, OpenAIError>

Builds a new CreateImageEditRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateImageEditRequestArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateImageEditRequestArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateImageEditRequestArgs

fn default() -> Self

Returns the “default value” for a type.