edit_image
Edit local images with a multipart Images Edits API, save results to a new absolute path, and preserve originals. Poll the returned job ID with get_job.
Instructions
Edit local images using the provider multipart Images Edits API. Saves to a new absolute path; preserves originals. Optional mask follows provider semantics. Poll returned job ID with get_job.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| n | No | Number of images; defaults to 1. May increase provider charges. | |
| size | No | Provider-supported size: auto or WIDTHxHEIGHT. Omit to use the provider default. Actual dimensions are returned. | |
| model | Yes | Exact model ID from list_models. Never invent or silently replace it. | |
| prompt | Yes | ||
| quality | No | Provider-supported quality, e.g. auto, low, medium, high, xhigh, max. Omit unless needed; availability varies by model. | |
| mask_path | No | Absolute local mask path. Follow provider requirements for transparency, dimensions and format. | |
| background | No | ||
| input_paths | Yes | Absolute paths to 1–16 local PNG/JPEG/WebP reference images; provider limits may be lower. | |
| output_path | Yes | Absolute output filename inside the current user workspace. Prefer output/imagegen/. Extension .png, .jpg, .jpeg or .webp selects output_format. Existing files are never overwritten. For n>1, -1, -2, etc. are appended. |