image-generation.edit
Edit an existing image or compose several images into one scene with Muse Image.
The user or agent passes stored file names from files.list_uploaded_files and/or public http or https image URLs. One image is an edit; several images are composed into one result.
The result is saved to account file storage. The response includes a signed URL for API users and download_code for agents to run vee3-get-file.
Cost = 50 tokens per generated image.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| n | No | Number of images to generate (1 to 10). Each returned image costs 50 tokens. | |
| size | No | Optional output size as WIDTHxHEIGHT (for example 1024x1536) or auto. This sets aspect ratio, not exact pixel size. Omit for the default aspect ratio. | |
| images | Yes | Source images as stored file names from files.list_uploaded_files and/or public http or https image URLs. One image is an edit. Several images are composed into one scene. Upload files with files.upload_file first. | |
| prompt | Yes | Text description of the image to generate or of the edit to apply. | |
| file_name | No | Optional account-relative storage path for the image. When n is greater than 1, an index is inserted before the extension (for example art/fox.webp becomes art/fox-1.webp and art/fox-2.webp). If omitted, the file is stored under image-generation/ with a generated name. | |
| output_format | No | Encoding of the returned image. webp is smaller; png is lossless. | webp |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | Echo of the requested size when one was passed. | |
| images | No | Generated images stored in account file storage. | |
| prompt | No | Echo of the requested prompt. | |
| status | No | Always "completed" for a successful generation. | |
| created_at | No | ISO 8601 timestamp. | |
| token_cost | No | Tokens charged for this request (50 times image_count). | |
| image_count | No | Number of images returned and billed. | |
| generation_id | No | Unique identifier, prefix igen_. | |
| output_format | No | Encoding of the stored images (webp, png, or jpeg). | |
| install_command | No | One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca. | |
| troubleshooting | No | What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps. |