Class: OpenAI::Resources::Images

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/images.rb,
sig/openai/resources/images.rbs

Overview

Given a prompt and/or an input image, the model will generate a new image.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Images

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Images.

Parameters:



598
599
600
 
# File 'lib/openai/resources/images.rb', line 598

def initialize(client:)
  @client = client
end

Instance Method Details

#create_variation(image:, model: nil, n: nil, response_format: nil, size: nil, user: nil, request_options: {}) ⇒ OpenAI::Models::ImagesResponse

Creates a variation of a given image. This endpoint only supports dall-e-2.

String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

Parameters:

  • image (Pathname, StringIO, IO, String, OpenAI::FilePart) —

    The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

    String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

  • model (String, Symbol, OpenAI::Models::ImageModel, nil) —

    The model to use for image generation. Only dall-e-2 is supported at this time.

  • n (Integer, nil) —

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

  • response_format (Symbol, OpenAI::Models::ImageCreateVariationParams::ResponseFormat, nil) —

    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.

  • size (Symbol, OpenAI::Models::ImageCreateVariationParams::Size, nil) —

    The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

  • user (String) —

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

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/openai/resources/images.rb', line 49

def create_variation(params)
  parsed, options = OpenAI::ImageCreateVariationParams.dump_request(params)
  @client.request(
    method: :post,
    path: "images/variations",
    headers: {"content-type" => "multipart/form-data"},
    body: parsed,
    model: OpenAI::ImagesResponse,
    security: {bearer_auth: true},
    options: options
  )
end

#edit(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {}) ⇒ OpenAI::Models::ImagesResponse

See OpenAI::Resources::Images#edit_stream_raw for streaming counterpart.

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

String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

Parameters:

  • image (Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>) —

    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, 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), 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.

    String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

  • prompt (String) —

    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 (Symbol, OpenAI::Models::ImageEditParams::Background, nil) —

    Allows to set transparency for the background of the generated image(s). 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.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. 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.

  • input_fidelity (Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil) —

    Controls fidelity to the original input image(s). This parameter is supported for GPT image models that support input fidelity. gpt-image-2 and gpt-image-2-2026-04-21 ignore this parameter.

  • mask (Pathname, StringIO, IO, String, OpenAI::FilePart) —

    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.

    String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

  • model (String, Symbol, OpenAI::Models::ImageModel, nil) —

    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, 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). Defaults to gpt-image-1.5.

  • n (Integer, nil) —

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

  • output_compression (Integer, nil) —

    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.

  • output_format (Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil) —

    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.

  • partial_images (Integer, nil) —

    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 (Symbol, OpenAI::Models::ImageEditParams::Quality, nil) —

    The quality of the image that will be generated for GPT image models. The GPT image models support low, medium, and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, also support xhigh and max. Defaults to auto.

  • response_format (Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil) —

    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 (String, Symbol, OpenAI::Models::ImageEditParams::Size, nil) —

    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. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

  • user (String) —

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

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/openai/resources/images.rb', line 185

def edit(params)
  parsed, options = OpenAI::ImageEditParams.dump_request(params)
  if parsed[:stream]
    message = "Please use `#edit_stream_raw` for the streaming use case."
    raise ArgumentError.new(message)
  end

  @client.request(
    method: :post,
    path: "images/edits",
    headers: {"content-type" => "multipart/form-data"},
    body: parsed,
    model: OpenAI::ImagesResponse,
    security: {bearer_auth: true},
    options: options
  )
end

#edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {}) ⇒ OpenAI::Internal::Stream<OpenAI::Models::ImageEditPartialImageEvent, OpenAI::Models::ImageEditCompletedEvent>

See OpenAI::Resources::Images#edit for non-streaming counterpart.

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

String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

Parameters:

  • image (Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>) —

    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, 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), 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.

    String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

  • prompt (String) —

    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 (Symbol, OpenAI::Models::ImageEditParams::Background, nil) —

    Allows to set transparency for the background of the generated image(s). 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.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. 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.

  • input_fidelity (Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil) —

    Controls fidelity to the original input image(s). This parameter is supported for GPT image models that support input fidelity. gpt-image-2 and gpt-image-2-2026-04-21 ignore this parameter.

  • mask (Pathname, StringIO, IO, String, OpenAI::FilePart) —

    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.

    String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

  • model (String, Symbol, OpenAI::Models::ImageModel, nil) —

    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, 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). Defaults to gpt-image-1.5.

  • n (Integer, nil) —

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

  • output_compression (Integer, nil) —

    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.

  • output_format (Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil) —

    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.

  • partial_images (Integer, nil) —

    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 (Symbol, OpenAI::Models::ImageEditParams::Quality, nil) —

    The quality of the image that will be generated for GPT image models. The GPT image models support low, medium, and high. gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, also support xhigh and max. Defaults to auto.

  • response_format (Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil) —

    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 (String, Symbol, OpenAI::Models::ImageEditParams::Size, nil) —

    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. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

  • user (String) —

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

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/openai/resources/images.rb', line 326

def edit_stream_raw(params)
  parsed, options = OpenAI::ImageEditParams.dump_request(params)
  unless parsed.fetch(:stream, true)
    message = "Please use `#edit` for the non-streaming use case."
    raise ArgumentError.new(message)
  end

  parsed.store(:stream, true)
  @client.request(
    method: :post,
    path: "images/edits",
    headers: {
      "content-type" => "multipart/form-data",
      "accept" => "text/event-stream",
      "accept-encoding" => "identity"
    },
    body: parsed,
    stream: OpenAI::Internal::Stream,
    model: OpenAI::ImageEditStreamEvent,
    security: {bearer_auth: true},
    options: options
  )
end

#generate(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {}) ⇒ OpenAI::Models::ImagesResponse

See OpenAI::Resources::Images#generate_stream_raw for streaming counterpart.

Creates an image given a prompt. Learn more.

Parameters:

  • prompt (String) —

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

  • background (Symbol, OpenAI::Models::ImageGenerateParams::Background, nil) —

    Allows to set transparency for the background of the generated image(s). 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.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. 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.

  • model (String, Symbol, OpenAI::Models::ImageModel, nil) —

    The model to use for image generation. One of dall-e-2, dall-e-3, 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, 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). Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.

  • moderation (Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil) —

    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).

  • n (Integer, nil) —

    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

  • output_compression (Integer, nil) —

    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.

  • output_format (Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil) —

    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.

  • partial_images (Integer, nil) —

    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 (Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil) —

    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.
    • hd and standard are supported for dall-e-3.
    • standard is the only option for dall-e-2.
  • response_format (Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil) —

    The format in which generated images with dall-e-2 and dall-e-3 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 isn't supported for the GPT image models, which always return base64-encoded images.

  • size (String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil) —

    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. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

  • style (Symbol, OpenAI::Models::ImageGenerateParams::Style, nil) —

    The style of the generated images. This parameter is only supported for dall-e-3. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

  • user (String) —

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

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/openai/resources/images.rb', line 454

def generate(params)
  parsed, options = OpenAI::ImageGenerateParams.dump_request(params)
  if parsed[:stream]
    message = "Please use `#generate_stream_raw` for the streaming use case."
    raise ArgumentError.new(message)
  end

  @client.request(
    method: :post,
    path: "images/generations",
    body: parsed,
    model: OpenAI::ImagesResponse,
    security: {bearer_auth: true},
    options: options
  )
end

#generate_stream_raw(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {}) ⇒ OpenAI::Internal::Stream<OpenAI::Models::ImageGenPartialImageEvent, OpenAI::Models::ImageGenCompletedEvent>

See OpenAI::Resources::Images#generate for non-streaming counterpart.

Creates an image given a prompt. Learn more.

Parameters:

  • prompt (String) —

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

  • background (Symbol, OpenAI::Models::ImageGenerateParams::Background, nil) —

    Allows to set transparency for the background of the generated image(s). 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.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. 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.

  • model (String, Symbol, OpenAI::Models::ImageModel, nil) —

    The model to use for image generation. One of dall-e-2, dall-e-3, 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, 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). Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.

  • moderation (Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil) —

    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).

  • n (Integer, nil) —

    The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

  • output_compression (Integer, nil) —

    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.

  • output_format (Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil) —

    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.

  • partial_images (Integer, nil) —

    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 (Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil) —

    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.
    • hd and standard are supported for dall-e-3.
    • standard is the only option for dall-e-2.
  • response_format (Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil) —

    The format in which generated images with dall-e-2 and dall-e-3 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 isn't supported for the GPT image models, which always return base64-encoded images.

  • size (String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil) —

    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. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

  • style (Symbol, OpenAI::Models::ImageGenerateParams::Style, nil) —

    The style of the generated images. This parameter is only supported for dall-e-3. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

  • user (String) —

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

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/openai/resources/images.rb', line 575

def generate_stream_raw(params)
  parsed, options = OpenAI::ImageGenerateParams.dump_request(params)
  unless parsed.fetch(:stream, true)
    message = "Please use `#generate` for the non-streaming use case."
    raise ArgumentError.new(message)
  end

  parsed.store(:stream, true)
  @client.request(
    method: :post,
    path: "images/generations",
    headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
    body: parsed,
    stream: OpenAI::Internal::Stream,
    model: OpenAI::ImageGenStreamEvent,
    security: {bearer_auth: true},
    options: options
  )
end