Method: accounts.generatedImages.removeProductImageBackground
Stay organized with collections
Save and categorize content based on your preferences.
generatedImages.removeProductImageBackground generates a new image where the background of the original image is removed.
HTTP request
POST https://merchantapi.googleapis.com/productstudio/v1alpha/{name=accounts/*}/generatedImages:removeProductImageBackground
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The account for which to generate an image. This acts as a container for the request and does not affect the generation itself. Format: accounts/{account}
|
Request body
The request body contains data with the following structure:
| Fields |
outputConfig |
object (OutputImageConfig)
Optional. Configuration for how the output image should be returned.
|
inputImage |
object (InputImage)
Required. The input image.
|
config |
object (RemoveImageBackgroundConfig)
Optional. Configuration parameters for the removal of the background.
|
Response body
Response message for the generatedImages.removeProductImageBackground method.
If successful, the response body contains data with the following structure:
| Fields |
generatedImage |
object (GeneratedImage)
The generated output image.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
RemoveImageBackgroundConfig
Client provided input configuration for removing the background.
| JSON representation |
{
"backgroundColor": {
object (RgbColor)
}
} |
| Fields |
backgroundColor |
object (RgbColor)
Optional. If set, the result of background removal will be an RGB image with this given color as the background, instead of an RGBA 4-channel transparent image.
|
RgbColor
Represents a color in RGB format.
| JSON representation |
{
"red": integer,
"green": integer,
"blue": integer
} |
| Fields |
red |
integer
Optional. Values in [0, 255].
|
green |
integer
Optional. Values in [0, 255].
|
blue |
integer
Optional. Values in [0, 255].
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-08 UTC.
[null,null,["Last updated 2025-07-08 UTC."],[],[],null,["# Method: accounts.generatedImages.removeProductImageBackground\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.RemoveProductImageBackgroundResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [RemoveImageBackgroundConfig](#RemoveImageBackgroundConfig)\n - [JSON representation](#RemoveImageBackgroundConfig.SCHEMA_REPRESENTATION)\n- [RgbColor](#RgbColor)\n - [JSON representation](#RgbColor.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\ngeneratedImages.removeProductImageBackground generates a new image where the background of the original image is removed.\n\n### HTTP request\n\n`POST https://merchantapi.googleapis.com/productstudio/v1alpha/{name=accounts/*}/generatedImages:removeProductImageBackground`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The account for which to generate an image. This acts as a container for the request and does not affect the generation itself. Format: accounts/{account} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"outputConfig\": { object (/merchant/api/reference/rest/productstudio_v1alpha/OutputImageConfig) }, \"inputImage\": { object (/merchant/api/reference/rest/productstudio_v1alpha/accounts.videos#InputImage) }, \"config\": { object (/merchant/api/reference/rest/productstudio_v1alpha/accounts.generatedImages/removeProductImageBackground#RemoveImageBackgroundConfig) } } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `outputConfig` | `object (`[OutputImageConfig](/merchant/api/reference/rest/productstudio_v1alpha/OutputImageConfig)`)` Optional. Configuration for how the output image should be returned. |\n| `inputImage` | `object (`[InputImage](/merchant/api/reference/rest/productstudio_v1alpha/accounts.videos#InputImage)`)` Required. The input image. |\n| `config` | `object (`[RemoveImageBackgroundConfig](/merchant/api/reference/rest/productstudio_v1alpha/accounts.generatedImages/removeProductImageBackground#RemoveImageBackgroundConfig)`)` Optional. Configuration parameters for the removal of the background. |\n\n### Response body\n\nResponse message for the generatedImages.removeProductImageBackground method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------|\n| ``` { \"generatedImage\": { object (/merchant/api/reference/rest/productstudio_v1alpha/GeneratedImage) } } ``` |\n\n| Fields ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------|\n| `generatedImage` | `object (`[GeneratedImage](/merchant/api/reference/rest/productstudio_v1alpha/GeneratedImage)`)` The generated output image. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nRemoveImageBackgroundConfig\n---------------------------\n\nClient provided input configuration for removing the background.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"backgroundColor\": { object (/merchant/api/reference/rest/productstudio_v1alpha/accounts.generatedImages/removeProductImageBackground#RgbColor) } } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `backgroundColor` | `object (`[RgbColor](/merchant/api/reference/rest/productstudio_v1alpha/accounts.generatedImages/removeProductImageBackground#RgbColor)`)` Optional. If set, the result of background removal will be an RGB image with this given color as the background, instead of an RGBA 4-channel transparent image. |\n\nRgbColor\n--------\n\nRepresents a color in RGB format.\n\n| JSON representation |\n|---------------------------------------------------------------|\n| ``` { \"red\": integer, \"green\": integer, \"blue\": integer } ``` |\n\n| Fields ||\n|---------|-------------------------------------------|\n| `red` | `integer` Optional. Values in \\[0, 255\\]. |\n| `green` | `integer` Optional. Values in \\[0, 255\\]. |\n| `blue` | `integer` Optional. Values in \\[0, 255\\]. |"]]
