SpyBara
Go Premium

resources/images/edit-streaming-events.md 2026-09-10 18:01 UTC to 2026-09-11 20:00 UTC

This page contains 170 additions and 1006 deletions.

2026
Wed 9 16:02 Fri 11 20:00 Fri 18 22:59

Image edit streaming events

For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.

Stream image generation and editing in real time with server-sent events. Learn more about image streaming.

image_edit.partial_image

Emitted when a partial image is available during image editing streaming.

Schema

Schema name: ImageEditPartialImageEvent

  • 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 3 more

    The quality setting for the requested edited image.

    • "low"

    • "medium"

    • "high"

    • "xhigh"

    • "max"

    • "auto"

  • size: string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"

    The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

    • string

    • "1024x1024" or "1024x1536" or "1536x1024" or "auto"

      The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

      • "1024x1024"

      • "1024x1536"

      • "1536x1024"

      • "auto"

  • type: "image_edit.partial_image"

    The type of the event. Always image_edit.partial_image.

    • "image_edit.partial_image"

Example

{
  "type": "image_edit.partial_image",
  "b64_json": "...",
  "created_at": 1620000000,
  "size": "1024x1024",
  "quality": "high",
  "background": "transparent",
  "output_format": "png",
  "partial_image_index": 0
}

image_edit.completed

Emitted when image editing has completed and the final image is available.

Schema

Schema name: ImageEditCompletedEvent

  • 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 3 more

    The quality setting for the edited image.

    • "low"

    • "medium"

    • "high"

    • "xhigh"

    • "max"

    • "auto"

  • size: string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"

    The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

    • string

    • "1024x1024" or "1024x1536" or "1536x1024" or "auto"

      The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

      • "1024x1024"

      • "1024x1536"

      • "1536x1024"

      • "auto"

  • type: "image_edit.completed"

    The type of the event. Always image_edit.completed.

    • "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.

Example

{
  "type": "image_edit.completed",
  "b64_json": "...",
  "created_at": 1620000000,
  "size": "1024x1024",
  "quality": "high",
  "background": "transparent",
  "output_format": "png",
  "usage": {
    "total_tokens": 100,
    "input_tokens": 50,
    "output_tokens": 50,
    "input_tokens_details": {
      "text_tokens": 10,
      "image_tokens": 40
    }
  }
}