Files

Edit image

Edit or combine workspace images with a compatible image model.

Image edits use the same reviewed Gateway catalog and workspace default as image generation.

Parameters#

promptstringrequired

Specific edit instructions, including what to change and preserve.

filepathsstring[]

Legacy list of source images. Do not combine with explicit source/reference/mask arguments.

file_suffixstringdefault: _edited

The suffix to append to the output file (e.g., "_edited" will create "image_edited.png"). Defaults to "_edited" if not specified.

providerstringdefault: ""

Deprecated compatibility alias: "google" or "openai". Prefer model.

modelstringdefault: ""

Optional public model ID. Empty uses the workspace default or compatible edit fallback.

source_filepathstringdefault: ""

Primary source image path.

reference_filepathsstring[]

Optional ordered additional source/reference image paths.

mask_filepathstringdefault: ""

Optional mask path. Rejected until a mask-capable public profile is enabled.

aspect_ratiostringdefault: 1:1

Requested output aspect ratio when the selected model supports it.

qualitystringdefault: ""

Optional normalized output quality.

nnumberdefault: 1

Requested output count. Current edit profiles produce one output.

sizestringdefault: ""

Optional exact output size for models that expose it.