v1

latestOpenAPI 3.0.42026-07-1376217536.1 KB
AiGenerator

Remove a background

AI Generator - Background Removal

Use of this endpoint is restricted to clients with an AI Generation license product and may result in the deduction of a credit depending on the terms of your license. When downloading an image generated using a reference_asset_id, a traditional license product, such as Premium Access, that provides download access to the original creative image is required. Downloading an image generated using a reference_asset_id also requires the client to first download the original image.

The Background Removal Request

The BackgroundRemovalRequest payload requires one, and only one, reference image (reference_asset_id, reference_generation) and accepts the following optional parameters:

ParameterPurpose
reference_asset_idCreative image id to modify.
reference_generationGeneration details of image to modify.
product_idIf you have multiple AI Generation Getty Images products, indicate which one you would like to use for this generation request. If you have multiple products, this property is required. Can be retrieved from products (GET /v3/products).
notesThis is an optional free text parameter often used by clients who wish to include notes specific to their integration. This is for use by Getty Images customers only (not iStock). The products endpoint (GET /v3/products) provides this information.
project_codeIf your Getty Images Generative AI product requires project_codes, use of this parameter is required. If your product does not require a project_code, this parameter must be excluded from the request. This is for use by Getty Images customers only (not iStock). The products endpoint (GET /v3/products) provides this information.

Fulfilled and Pending Results

In many cases the result of this call will be the final fulfilled result. In these cases, you will see a HTTP 200 OK result and a payload including URLs to the result images and a generation_request_id value.

However some generations may take more time than can be accommodated in the initial call. In these cases the result of this call is HTTP 202 Accepted and the payload will only contain a generation_request_id value. This value must be retained by the client for subsequent polling of the GET v3/ai/image-generations/{generationRequestId} Get Images Generation endpoint.

Lifetime of Generated Images

Generated images will be retained for 6 months after generation.

post/v3/ai/image-generations/background-removal

Request body

reference_asset_idstring nullable

Asset Id to modify.

product_idinteger nullable

If you have multiple Getty products, indicate which one you would like to use for this refine request

project_codestring nullable

The project code to use for the request. Some products require this value.

notesstring nullable

The notes to use for the request. Some products require this value.

Response

Returns the request ID for a pending request to extend an image

generation_request_idstring nullable