Edit Image
Generative image edit — the same primitive with required source_images (metered).
Authorizations
API key from Settings > Developer > REST API
Headers
Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.
2026-04-12, 2026-05-01 "2026-05-01"
Body
Sent to the selected model VERBATIM.
1Concrete registry model id (no 'auto'); see GET /v1/media/models.
The image(s) to edit — required on this verb: file_ ids or http(s) URLs.
11 <= x <= 4x > 0x > 0Style/subject/composition references: file_ ids or http(s) URLs.
A retried call with the same key replays the stored response (replayed:true) instead of paying for a second provider render.
200Response
Successful Response
The response is of type Response Mediaeditimage · object.