v1

latestOpenAPI 3.0.42026-07-1376217536.1 KB
AiGenerator

Extend an image

AI Generator - Image Extension

Use text prompts and numerical values to extend the content beyond the borders of an image from the Getty Images creative library (excluding certain vectors) or a previously generated 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. To download an extended image, a traditional license product, such as Premium Access, that provides download access to the original creative image is required. Lastly, downloading an extended image requires the client to first download the original image.

Extension involves adding content to one or more sides of an image by specifying a percentage by which you want the image extended. This means that the aspect ratio of the generated images will differ from the original unless the same value is specified for all four sides. Additionally, the pixel dimensions on the longest side will remain the same - 612px for the images provided in this endpoint's response, 1024px and 4096px on the images retrieved through the download process.

The Extend Request

The ExtendRequest payload requires one, and only one, reference image (reference_asset_id, reference_generation) and requires at least one percentage to be greater than zero (left_percentage, right_percentage, top_percentage, or bottom_percentage) and accepts the following optional parameters:

ParameterPurpose
reference_asset_idCreative image id to modify.
reference_generationGeneration details of image to modify.
promptThe primary text used for the extended portion of the images.
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.
left_percentagePercentage to add to the left side of the image. This must be a float that is equal to or greater than 0. Default is 0.
right_percentagePercentage to add to the right side of the image. This must be a float that is equal to or greater than 0. Default is 0.
top_percentagePercentage to add to the top side of the image. This must be a float that is equal to or greater than 0. Default is 0.
bottom_percentagePercentage to add to the bottom side of the image. This must be a float that is equal to or greater than 0. Default is 0.

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/extend

Request body

reference_asset_idstring nullable
promptstring nullable
product_idinteger nullable
project_codestring nullable
notesstring nullable
left_percentagenumber float
right_percentagenumber float
top_percentagenumber float
bottom_percentagenumber float

Response

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

generation_request_idstring nullable