Edit images

string

Required. The type of reference image. One of the following:

• REFERENCE_TYPE_RAW : The base image to edit.
• REFERENCE_TYPE_MASK : The mask image, whose non-zero values indicate where to edit the base image.

integer

Required. A unique identifier for the reference image. Not used for masked editing.

string

Required. Base64-encoded image bytes. Accepts PNG, JPEG, GIF, and BMP files. The maximum size is 20MB after transcoding to PNG. If you provide a mask image, it must be the same dimensions as the base image.

string

Required when referenceType is REFERENCE_TYPE_MASK . Must be one of the following:

• MASK_MODE_USER_PROVIDED : Use the mask from referenceImage.bytesBase64Encoded .
• MASK_MODE_BACKGROUND : Use an auto-generated mask from background segmentation.
• MASK_MODE_FOREGROUND : Use an auto-generated mask from foreground segmentation.
• MASK_MODE_SEMANTIC : Use an auto-generated mask from semantic segmentation with the given mask class.

float

Optional. Range: [0, 1]. The percentage of image width to dilate (grow) the mask by. This can help compensate for imprecise masks. For best results, we recommend the following maskImageConfig.maskMode settings, we recommend the listed values:

• EDIT_MODE_INPAINT_INSERTION : 0.01
• EDIT_MODE_INPAINT_REMOVAL : 0.01
• EDIT_MODE_BGSWAP : 0.0
• EDIT_MODE_OUTPAINT : 0.01 - 0.03

list[integer]

Optional. Mask classes for MASK_MODE_SEMANTIC mode.

bool

Optional. Add an invisible watermark to the generated images.

The default value is true .

integer

Optional. The number of sampling steps. A higher value has better image quality, while a lower value has better latency. Defaults to 75 .

For smaller mask areas or for removal or insert modes, use 16 - 35 steps to reduce latency while returning a similar level of quality.

string

Required for mask editing.

An enum with one of the following values:

• EDIT_MODE_INPAINT_REMOVAL : Remove objects and fill in the image background in the mask area.
• EDIT_MODE_INPAINT_INSERTION : Add objects from a given prompt.
• EDIT_MODE_BGSWAP : Add background content in the mask area, while preserving the object content in the unmasked area. Useful for product editing.
• EDIT_MODE_OUTPAINT : Extends the image into the mask area. Unlike EDIT_MODE_BGSWAP , this will generate object completion for partial objects at the image boundary.

integer

Optional. Controls how much the model adheres to the text prompt. Large values increase output and prompt alignment, but might compromise image quality.

Accepted range: 0 - 500

Default: 60 for insert mode, 75 for remove, bgswap, outpaint.

boolean

Optional. Whether to include a safety reason for filtered images in the response. The default value is false .

boolean

Optional. Whether to report the safety scores of each image in the response. The default value is false .

string

Optional. The language code that corresponds to your text prompt language. The following values are supported:

• "auto" : Automatic detection. If Imagen detects a supported language, the prompt and an optional negative prompt are translated to English. If the language detected isn't supported, Imagen uses the input text verbatim, which might result in an unexpected output. No error code is returned.
• "en" : English (if omitted, the default value)
• "zh" or "zh-CN" : Chinese (simplified)
• "zh-TW" : Chinese (traditional)
• "hi" : Hindi
• "ja" : Japanese
• "ko" : Korean
• "pt" : Portuguese
• "es" : Spanish

language is supported only by imagen-3.0-capability-001 .

string

Optional. A description of what to discourage in the generated images.

outputOptions

Optional. Describes the output image format in an outputOptions object.

string

Optional. Allow generation of people by the model. The following values are supported:

• "dont_allow" : Disallow the inclusion of people or faces in images.
• "allow_adult" : Allow generation of adults only.
• "allow_all" : Allow generation of people of all ages.

For mask-based editing personGeneration defaults to allow_adult . For mask-free editing, personGeneration defaults to allow_adult .

integer

Optional. The number of images to generate. The default value is 4.

Uint32

Optional. The random seed for image generation. This isn't available when addWatermark is set to true .

string

Optional. Adds a filter level to safety filtering. The following values are supported:

• "block_low_and_above" : Strongest filtering level, most strict blocking. Deprecated value: "block_most" .
• "block_medium_and_above" : Block some problematic prompts and responses. Deprecated value: "block_some" .
• "block_only_high" : Reduces the number of requests blocked due to safety filters. May increase objectionable content generated by Imagen. Deprecated value: "block_few" .
• "block_none" : Block very few problematic prompts and responses. Access to this feature is restricted. Previous field value: "block_fewest" .

The default value is "block_medium_and_above" .

safetySetting is supported only by imagen-3.0-capability-001 .

string

Optional. The Cloud Storage URI to store the generated images.

string

Optional. The image format that the output should be saved as. The following values are supported:

• "image/png" : Save as a PNG image
• "image/jpeg" : Save as a JPEG image

The default value is "image/png" .

integer

Optional. The level of compression if the output type is "image/jpeg" . Accepted values are 0 through 100 . The default value is 75 .