| --aspect-ratio |
string |
Aspect ratio (e.g., 3:2, 16:9) (default "3:2") |
| --caption |
string |
Caption for the edited images (defaults to prompt) |
| --count int |
bool |
Number of image variations to request (default 1) |
| -h, --help |
bool |
help for edit-image |
| --image-index int |
bool |
Index of the image within the message to edit (0-based) |
| --include-safety |
bool |
Request safety metadata in the response |
| --json |
bool |
Output result as JSON |
| --mask-file |
string |
Path to an optional mask image limiting edits |
| --mask-mime-type |
string |
Explicit MIME type for the mask file (auto-detected if omitted) |
| --mask-strength float |
bool |
Mask strength between 0 and 1 |
| --message-id |
string |
ID of the message containing the image to edit (required) |
| --mime-type |
string |
Preferred output MIME type (default "image/png") |
| --model |
string |
Model to use (defaults to server-side configuration) |
| --negative |
string |
Negative prompt describing what to avoid |
| --reply-to |
string |
Message ID to reply to |
| --request-id |
string |
Optional idempotency key for the generation request |
| --seed int |
bool |
Random seed for deterministic outputs |
| --watermark |
bool |
Request provider watermark on generated images |