# Images ## Create image `$ openai images generate` **post** `/images/generations` Creates an image given a prompt. [Learn more](https://platform.openai.com/docs/guides/images). ### 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: optional "transparent" or "opaque" or "auto"` 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`. - `--model: optional string or ImageModel` 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`, or `gpt-image-2-2026-04-21`). Defaults to `dall-e-2` unless a parameter specific to the GPT image models is used. - `--moderation: optional "low" or "auto"` 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: optional number` The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported. - `--output-compression: optional number` 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: optional "png" or "jpeg" or "webp"` 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: optional number` 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: optional "standard" or "hd" or "low" or 3 more` 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. - `hd` and `standard` are supported for `dall-e-3`. - `standard` is the only option for `dall-e-2`. - `--response-format: optional "url" or "b64_json"` 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: optional string or "auto" or "1024x1024" or "1536x1024" or 5 more` 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`. - `--style: optional "vivid" or "natural"` 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: optional string` A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). ### Returns - `images_response: object { created, background, data, 4 more }` The response from the image generation endpoint. - `created: number` The Unix timestamp (in seconds) of when the image was created. - `background: optional "transparent" or "opaque"` The background parameter used for the image generation. Either `transparent` or `opaque`. - `"transparent"` - `"opaque"` - `data: optional array of Image` The list of generated images. - `b64_json: optional string` The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`. - `revised_prompt: optional string` For `dall-e-3` only, the revised prompt that was used to generate the image. - `url: optional string` When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for the GPT image models. - `output_format: optional "png" or "webp" or "jpeg"` The output format of the image generation. Either `png`, `webp`, or `jpeg`. - `"png"` - `"webp"` - `"jpeg"` - `quality: optional "low" or "medium" or "high"` The quality of the image generated. Either `low`, `medium`, or `high`. - `"low"` - `"medium"` - `"high"` - `size: optional "1024x1024" or "1024x1536" or "1536x1024"` The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }` For `gpt-image-1` only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of output tokens generated by the model. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. - `output_tokens_details: optional object { image_tokens, text_tokens }` The output token details for the image generation. - `image_tokens: number` The number of image output tokens generated by the model. - `text_tokens: number` The number of text output tokens generated by the model. ### Example ```cli openai images generate \ --api-key 'My API Key' \ --prompt 'A cute baby sea otter' ``` #### Response ```json { "created": 0, "background": "transparent", "data": [ { "b64_json": "b64_json", "revised_prompt": "revised_prompt", "url": "https://example.com" } ], "output_format": "png", "quality": "low", "size": "1024x1024", "usage": { "input_tokens": 0, "input_tokens_details": { "image_tokens": 0, "text_tokens": 0 }, "output_tokens": 0, "total_tokens": 0, "output_tokens_details": { "image_tokens": 0, "text_tokens": 0 } } } ``` ## Create image edit `$ openai images edit` **post** `/images/edits` Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`, `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`. ### Parameters - `--image: string or array of string` 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: 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: optional "transparent" or "opaque" or "auto"` 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`. - `--input-fidelity: optional "high" or "low"` 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: optional string` 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: optional string or ImageModel` 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: optional number` The number of images to generate. Must be between 1 and 10. - `--output-compression: optional number` 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: optional "png" or "jpeg" or "webp"` 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: optional number` 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: optional "standard" or "low" or "medium" or 2 more` The quality of the image that will be generated for GPT image models. Defaults to `auto`. - `--response-format: optional "url" or "b64_json"` 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: optional string or "256x256" or "512x512" or "1024x1024" or 3 more` 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: optional string` A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). ### Returns - `images_response: object { created, background, data, 4 more }` The response from the image generation endpoint. - `created: number` The Unix timestamp (in seconds) of when the image was created. - `background: optional "transparent" or "opaque"` The background parameter used for the image generation. Either `transparent` or `opaque`. - `"transparent"` - `"opaque"` - `data: optional array of Image` The list of generated images. - `b64_json: optional string` The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`. - `revised_prompt: optional string` For `dall-e-3` only, the revised prompt that was used to generate the image. - `url: optional string` When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for the GPT image models. - `output_format: optional "png" or "webp" or "jpeg"` The output format of the image generation. Either `png`, `webp`, or `jpeg`. - `"png"` - `"webp"` - `"jpeg"` - `quality: optional "low" or "medium" or "high"` The quality of the image generated. Either `low`, `medium`, or `high`. - `"low"` - `"medium"` - `"high"` - `size: optional "1024x1024" or "1024x1536" or "1536x1024"` The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }` For `gpt-image-1` only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of output tokens generated by the model. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. - `output_tokens_details: optional object { image_tokens, text_tokens }` The output token details for the image generation. - `image_tokens: number` The number of image output tokens generated by the model. - `text_tokens: number` The number of text output tokens generated by the model. ### Example ```cli openai images edit \ --api-key 'My API Key' \ --image 'Example data' \ --prompt 'A cute baby sea otter wearing a beret' ``` #### Response ```json { "created": 0, "background": "transparent", "data": [ { "b64_json": "b64_json", "revised_prompt": "revised_prompt", "url": "https://example.com" } ], "output_format": "png", "quality": "low", "size": "1024x1024", "usage": { "input_tokens": 0, "input_tokens_details": { "image_tokens": 0, "text_tokens": 0 }, "output_tokens": 0, "total_tokens": 0, "output_tokens_details": { "image_tokens": 0, "text_tokens": 0 } } } ``` ## Create image variation `$ openai images create-variation` **post** `/images/variations` Creates a variation of a given image. This endpoint only supports `dall-e-2`. ### Parameters - `--image: string` The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square. - `--model: optional string or ImageModel` The model to use for image generation. Only `dall-e-2` is supported at this time. - `--n: optional number` The number of images to generate. Must be between 1 and 10. - `--response-format: optional "url" or "b64_json"` 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: optional "256x256" or "512x512" or "1024x1024"` The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`. - `--user: optional string` A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). ### Returns - `images_response: object { created, background, data, 4 more }` The response from the image generation endpoint. - `created: number` The Unix timestamp (in seconds) of when the image was created. - `background: optional "transparent" or "opaque"` The background parameter used for the image generation. Either `transparent` or `opaque`. - `"transparent"` - `"opaque"` - `data: optional array of Image` The list of generated images. - `b64_json: optional string` The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`. - `revised_prompt: optional string` For `dall-e-3` only, the revised prompt that was used to generate the image. - `url: optional string` When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for the GPT image models. - `output_format: optional "png" or "webp" or "jpeg"` The output format of the image generation. Either `png`, `webp`, or `jpeg`. - `"png"` - `"webp"` - `"jpeg"` - `quality: optional "low" or "medium" or "high"` The quality of the image generated. Either `low`, `medium`, or `high`. - `"low"` - `"medium"` - `"high"` - `size: optional "1024x1024" or "1024x1536" or "1536x1024"` The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }` For `gpt-image-1` only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of output tokens generated by the model. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. - `output_tokens_details: optional object { image_tokens, text_tokens }` The output token details for the image generation. - `image_tokens: number` The number of image output tokens generated by the model. - `text_tokens: number` The number of text output tokens generated by the model. ### Example ```cli openai images create-variation \ --api-key 'My API Key' \ --image 'Example data' ``` #### Response ```json { "created": 0, "background": "transparent", "data": [ { "b64_json": "b64_json", "revised_prompt": "revised_prompt", "url": "https://example.com" } ], "output_format": "png", "quality": "low", "size": "1024x1024", "usage": { "input_tokens": 0, "input_tokens_details": { "image_tokens": 0, "text_tokens": 0 }, "output_tokens": 0, "total_tokens": 0, "output_tokens_details": { "image_tokens": 0, "text_tokens": 0 } } } ``` ## Domain Types ### Image - `image: object { b64_json, revised_prompt, url }` Represents the content or the URL of an image generated by the OpenAI API. - `b64_json: optional string` The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`. - `revised_prompt: optional string` For `dall-e-3` only, the revised prompt that was used to generate the image. - `url: optional string` When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for the GPT image models. ### Image Edit Completed Event - `image_edit_completed_event: object { b64_json, background, created_at, 5 more }` Emitted when image editing has completed and the final image is available. - `b64_json: string` Base64-encoded final edited image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the edited image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the edited image. - `"png"` - `"webp"` - `"jpeg"` - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the edited image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the edited image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_edit.completed"` The type of the event. Always `image_edit.completed`. - `usage: object { input_tokens, input_tokens_details, output_tokens, total_tokens }` For the GPT image models only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of image tokens in the output image. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. ### Image Edit Partial Image Event - `image_edit_partial_image_event: object { b64_json, background, created_at, 5 more }` Emitted when a partial image is available during image editing streaming. - `b64_json: string` Base64-encoded partial image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the requested edited image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the requested edited image. - `"png"` - `"webp"` - `"jpeg"` - `partial_image_index: number` 0-based index for the partial image (streaming). - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the requested edited image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the requested edited image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_edit.partial_image"` The type of the event. Always `image_edit.partial_image`. ### Image Edit Stream Event - `image_edit_stream_event: ImageEditPartialImageEvent or ImageEditCompletedEvent` Emitted when a partial image is available during image editing streaming. - `image_edit_partial_image_event: object { b64_json, background, created_at, 5 more }` Emitted when a partial image is available during image editing streaming. - `b64_json: string` Base64-encoded partial image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the requested edited image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the requested edited image. - `"png"` - `"webp"` - `"jpeg"` - `partial_image_index: number` 0-based index for the partial image (streaming). - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the requested edited image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the requested edited image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_edit.partial_image"` The type of the event. Always `image_edit.partial_image`. - `image_edit_completed_event: object { b64_json, background, created_at, 5 more }` Emitted when image editing has completed and the final image is available. - `b64_json: string` Base64-encoded final edited image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the edited image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the edited image. - `"png"` - `"webp"` - `"jpeg"` - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the edited image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the edited image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_edit.completed"` The type of the event. Always `image_edit.completed`. - `usage: object { input_tokens, input_tokens_details, output_tokens, total_tokens }` For the GPT image models only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of image tokens in the output image. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. ### Image Gen Completed Event - `image_gen_completed_event: object { b64_json, background, created_at, 5 more }` Emitted when image generation has completed and the final image is available. - `b64_json: string` Base64-encoded image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the generated image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the generated image. - `"png"` - `"webp"` - `"jpeg"` - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the generated image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the generated image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_generation.completed"` The type of the event. Always `image_generation.completed`. - `usage: object { input_tokens, input_tokens_details, output_tokens, total_tokens }` For the GPT image models only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of image tokens in the output image. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. ### Image Gen Partial Image Event - `image_gen_partial_image_event: object { b64_json, background, created_at, 5 more }` Emitted when a partial image is available during image generation streaming. - `b64_json: string` Base64-encoded partial image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the requested image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the requested image. - `"png"` - `"webp"` - `"jpeg"` - `partial_image_index: number` 0-based index for the partial image (streaming). - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the requested image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the requested image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_generation.partial_image"` The type of the event. Always `image_generation.partial_image`. ### Image Gen Stream Event - `image_gen_stream_event: ImageGenPartialImageEvent or ImageGenCompletedEvent` Emitted when a partial image is available during image generation streaming. - `image_gen_partial_image_event: object { b64_json, background, created_at, 5 more }` Emitted when a partial image is available during image generation streaming. - `b64_json: string` Base64-encoded partial image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the requested image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the requested image. - `"png"` - `"webp"` - `"jpeg"` - `partial_image_index: number` 0-based index for the partial image (streaming). - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the requested image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the requested image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_generation.partial_image"` The type of the event. Always `image_generation.partial_image`. - `image_gen_completed_event: object { b64_json, background, created_at, 5 more }` Emitted when image generation has completed and the final image is available. - `b64_json: string` Base64-encoded image data, suitable for rendering as an image. - `background: "transparent" or "opaque" or "auto"` The background setting for the generated image. - `"transparent"` - `"opaque"` - `"auto"` - `created_at: number` The Unix timestamp when the event was created. - `output_format: "png" or "webp" or "jpeg"` The output format for the generated image. - `"png"` - `"webp"` - `"jpeg"` - `quality: "low" or "medium" or "high" or "auto"` The quality setting for the generated image. - `"low"` - `"medium"` - `"high"` - `"auto"` - `size: "1024x1024" or "1024x1536" or "1536x1024" or "auto"` The size of the generated image. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `"auto"` - `type: "image_generation.completed"` The type of the event. Always `image_generation.completed`. - `usage: object { input_tokens, input_tokens_details, output_tokens, total_tokens }` For the GPT image models only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of image tokens in the output image. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. ### Image Model - `image_model: "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-2" or 5 more` - `"gpt-image-1"` - `"gpt-image-1-mini"` - `"gpt-image-2"` - `"gpt-image-2-2026-04-21"` - `"gpt-image-1.5"` - `"chatgpt-image-latest"` - `"dall-e-2"` - `"dall-e-3"` ### Images Response - `images_response: object { created, background, data, 4 more }` The response from the image generation endpoint. - `created: number` The Unix timestamp (in seconds) of when the image was created. - `background: optional "transparent" or "opaque"` The background parameter used for the image generation. Either `transparent` or `opaque`. - `"transparent"` - `"opaque"` - `data: optional array of Image` The list of generated images. - `b64_json: optional string` The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`. - `revised_prompt: optional string` For `dall-e-3` only, the revised prompt that was used to generate the image. - `url: optional string` When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for the GPT image models. - `output_format: optional "png" or "webp" or "jpeg"` The output format of the image generation. Either `png`, `webp`, or `jpeg`. - `"png"` - `"webp"` - `"jpeg"` - `quality: optional "low" or "medium" or "high"` The quality of the image generated. Either `low`, `medium`, or `high`. - `"low"` - `"medium"` - `"high"` - `size: optional "1024x1024" or "1024x1536" or "1536x1024"` The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`. - `"1024x1024"` - `"1024x1536"` - `"1536x1024"` - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }` For `gpt-image-1` only, the token usage information for the image generation. - `input_tokens: number` The number of tokens (images and text) in the input prompt. - `input_tokens_details: object { image_tokens, text_tokens }` The input tokens detailed information for the image generation. - `image_tokens: number` The number of image tokens in the input prompt. - `text_tokens: number` The number of text tokens in the input prompt. - `output_tokens: number` The number of output tokens generated by the model. - `total_tokens: number` The total number of tokens (images and text) used for the image generation. - `output_tokens_details: optional object { image_tokens, text_tokens }` The output token details for the image generation. - `image_tokens: number` The number of image output tokens generated by the model. - `text_tokens: number` The number of text output tokens generated by the model.