v1

latestOpenAPI 3.1.02026-08-063282108.5 KB

generate

Edit (legacy)

Edit a given image synchronously using the provided mask. The mask indicates which part of the image should be edited, while the prompt and chosen style type can further guide the edit.

Supported image formats include JPEG, PNG, and WebP.

Images links are available for a limited period of time; if you would like to keep the image, you must download it.

post/edit

Headers

Api-Keystring required

API key for access control. Use in the header with the name "Api-Key"

Response

Image edits generated successfully.

request_idstring

URL-safe base64 ID of the sampling request. Present when the caller supplied webhook_url and the request was accepted for async delivery; in that case data is omitted and the generated images will be POSTed to the customer's webhook_url when ready.

createdstring date-time required

The time the request was created.