v1

latestOpenAPI 3.0.42026-07-1376217536.1 KB

AiGenerator

Influence the color of generated images using a reference image

AI Generator - Influence Color By Image

Influence Color By Image allows the client application to provide an existing Getty Images creative image or an existing generated image, along with prompt text, as a reference for generating new images. The generated images are influenced by the color palette, tone and location of colors within the reference image.

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 generating new images using using a reference_asset_id, the reference image must first be licensed (downloaded) through a traditional license product such as Premium Access before the generated image can be downloaded..

The Influence Color By Image Request

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

Parameter	Purpose
reference_asset_id	Creative image ID of the image being used as a reference.
reference_generation	Generation details of the image being used as a reference.
reference_file_registration_id	Registered file id of the image being used as a reference. The ImageReference category must be used when registering the file.
prompt Required	The primary text used for the generation of the images.
media_type	Media type of the results: photography or illustration
product_id	If 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).
notes	This 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_code	If 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/influence-color-by-image

Request body

reference_asset_idstring nullable

Asset Id to modify.

reference_file_registration_idstring nullable

File Id to modify.

promptstring nullable

This is the primary text used for refining the images.

media_type'photography' | 'illustration'

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