Skip to main content
POST
  • Uses the same /v1/images/generations endpoint as text-to-image generation
  • Editing mode is triggered automatically when image_urls is included in the request
  • Supports multi-reference blending (up to 16 images) and mask-based inpainting
  • Reference images must be publicly accessible PNG / JPG, max 50MB each
Image editing is fully compatible with the generation API: simply add image_urls (and optionally mask_url) to your generation request — no endpoint switch required.

Authorizations

string
required
All endpoints require Bearer Token authenticationGet your API Key from the API Key Management Page

Body

string
default:"gpt-image-2"
required
Use gpt-image-2
string
required
Describe the desired editExample: "Replace the background with a starry sky, keep the subject unchanged"
string[]
required
Reference image URL array (the field that triggers editing mode)
  • Maximum 16 images
  • Must be publicly accessible stable URLs (PNG / JPG, max 50MB each)
  • Use the Upload Image API to get URLs for local files
string
Mask image URL for inpainting
  • Must be PNG format with an Alpha channel
  • Transparent areas (alpha = 0) will be repainted; opaque areas are preserved
  • Must match the dimensions of the first reference image
string
default:"1:1"
Output aspect ratioSupports 13 ratios or auto:1:1 · 3:2 · 2:3 · 4:3 · 3:4 · 5:4 · 4:5 · 16:9 · 9:16 · 2:1 · 1:2 · 21:9 · 9:21
string
default:"1k"
Resolution tier: 1k / 2k / 4k1K and 2K support all 13 ratios. 4K only supports 6 ratios: 16:9 / 9:16 / 2:1 / 1:2 / 21:9 / 9:21
string
default:"high"
Image quality: low / medium / high
integer
default:1
Number of images to generate, range 1 ~ 10
string
default:"png"
Output format: png / jpeg
Azure OpenAI does not support webp format.
integer
default:100
JPEG compression level, range 0–100 (only applies when output_format is "jpeg")

Response

string
Unique task identifier for status queries
string
Always generation.task
string
Task status: queued / in_progress / completed / failed
integer
Task progress percentage (0-100)
integer
Task creation timestamp (Unix timestamp)