Struct CreateImageRequestArgs 

pub struct CreateImageRequestArgs { /* private fields */ }

Available on crate feature image-types only.

Builder for CreateImageRequest.

Implementations

impl CreateImageRequestArgs

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.

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

The GPT image model to use for image generation. Specify a model explicitly. Supported models include 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, and 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 quality<VALUE: Into<ImageQuality>>(&mut self, value: VALUE) -> &mut Self

The quality of the image that will be generated.

• auto (default value) will automatically select the best quality for the given model.
• high, medium and low are supported for the GPT image models.
• gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, also support xhigh and max.

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.

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 stream<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Generate the image in streaming mode. Defaults to false. See the Image generation guide for more information. This parameter is only supported for the GPT image models.

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 size<VALUE: Into<ImageSize>>(&mut self, value: VALUE) -> &mut Self

The size of the generated images. 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 moderation<VALUE: Into<ImageModeration>>( &mut self, value: VALUE, ) -> &mut Self

Control the content-moderation level for images generated by the GPT image models. Must be either low for less restrictive filtering or auto (default value).

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 style<VALUE: Into<ImageStyle>>(&mut self, value: VALUE) -> &mut Self

Legacy style parameter for retired image models. Unsupported for GPT image models; describe the desired style in the prompt instead.

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 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 build(&self) -> Result<CreateImageRequest, OpenAIError>

Builds a new CreateImageRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateImageRequestArgs

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 CreateImageRequestArgs

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

Formats the value using the given formatter.

impl Default for CreateImageRequestArgs

fn default() -> Self

Returns the “default value” for a type.