Edit image
edit_image_fileEdit existing images by uploading source files or passing image URLs with a prompt for supported GPT Image models; optionally apply masks and set output format.
Instructions
Edits an image using multipart image uploads, JSON image URLs, or the official JSON images array for supported GPT Image models.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| n | No | ||
| mask | No | Pass local file path. | |
| size | No | ||
| user | No | ||
| async | No | ||
| image | No | Source image file(s). Repeat image for multiple source images. GPT Image edits accept up to 16 imag… | |
| model | Yes | Model to use for image edits. Send this explicitly, for example gpt-image-2. | |
| prompt | Yes | ||
| image[] | No | Alternative repeated multipart field name for multiple source images. The same model-specific limit… | |
| quality | No | ||
| background | No | ||
| moderation | No | ||
| resolution | No | ||
| compression | No | ||
| aspect_ratio | No | ||
| output_format | No | ||
| response_format | No | ||
| output_compression | No | ||
| X-TokenLab-Delivery-Policy | No | Per-request Delivery policy. Overrides the API key and Workspace defaults. Auto tries TokenLab Veri… |