{"note":"OpenAPI conversion -- returning structured metadata","name":"gettyimages-com","description":"Getty Images API","version":"3","base_url":"","endpoints":76,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Getty Images API\n@version 3\n@auth ApiKey Api-Key in header | OAuth2\n@endpoints 76\n@hint download_for_search\n@toc affiliates(2), ai(22), artists(2), asset-changes(3), asset-licensing(1), boards(14), collections(1), countries(1), customers(1), downloads(3), events(2), image-match(1), images(5), orders(1), products(1), purchased-assets(1), search(9), usage-batches(1), videos(5)\n\n@group affiliates\n@endpoint GET /v3/affiliates/search/images\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., phrase: str # Search images using a search phrase., style: str # Filter based on graphical style of the image.}\n@returns(200) {images: [map]?, auto_corrections: map{phrase: str?}} # OK\n\n@endpoint GET /v3/affiliates/search/videos\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., phrase: str}\n@returns(200) {videos: [map]?, auto_corrections: map{phrase: str?}} # OK\n\n@endgroup\n\n@group ai\n@endpoint POST /v3/ai/image-generations\n@desc Generates images from a prompt\n@optional {prompt: str # The only required parameter, this is the primary text used for the generation of the images., aspect_ratio: str # Aspect ratio of the result images.  Must be one of 1:1, 3:4, 4:3, 9:16, or 16:9, media_type: str(photography/illustration), mood: str(black_and_white/warm/cool/natural/vivid/dramatic/bold), product_id: int(int32) # If you have multiple Getty products, indicate which one you would like to use for this generation request, project_code: str # The project code to use for the generation request.  Some products require this value., notes: str # The notes to use for the generation request.  Some products require this value.}\n@returns(202) {generation_request_id: str?} # Returns the request ID\n@errors {400: The request was invalid, 403: Product quota exceeded, 409: ConcurrencyConflict, 429: TooManyConcurrentGenerations}\n\n@endpoint GET /v3/ai/image-generations/{generationRequestId}\n@desc Get generated images from a previous generation request\n@required {generationRequestId: str # The ID from a previous request to generate images}\n@returns(200) {generation_request_id: str?, seed: int(int32)?, results: [map]?, original_asset: map{id: str?}} # Returns the result of a request to generate images\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request\n@errors {400: InvalidProduct, 403: NoProducts, 404: The request ID was not found, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/{generationRequestId}/images/{index}/variations\n@desc Get variations on a generated image\n@required {generationRequestId: str # The ID from a previous request to generate images, index: int(int32) # The index of the image from the specific images generation}\n@optional {product_id: int(int32) # If you have multiple Getty products, indicate which one you would like to use for this generation request, project_code: str # The project code to use for the generation request.  Some products require this value., notes: str # The notes to use for the generation request.  Some products require this value.}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to generate a variation of images\n@errors {400: InvalidProduct, 403: Product quota exceeded, 404: Either the generation id does not exist, the index is incorrect, or the generation is still pending, 409: ConcurrencyConflict, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/file-registrations\n@desc Register a client provided file for use with AIGenerator endpoints\n@optional {url: str # The location of the file., rights_claimed: bool # Acknowledgment of ownership or licensing of file., category: str(ImageReference/CustomerProduct)}\n@returns(200) {id: str?} # Returns the response\n@errors {400: The request was invalid, 403: Not authorized}\n\n@endpoint GET /v3/ai/file-registrations\n@optional {page: int(int32) # The page number of results.  Default is 1., page_size: int(int32) # The page size of results.  Default is 30.}\n@returns(200) {result_count: int(int32), file_registrations: [map]?} # OK\n@errors {403: NotAuthorized}\n\n@endpoint GET /v3/ai/file-registrations/{fileRegistrationId}\n@desc Get details on a registered file\n@required {fileRegistrationId: str # The id from a previous request to register a file}\n@returns(200) {id: str?, preview_urls: [map]?} # Returns the response\n@errors {400: The request was invalid, 403: Not authorized, 404: FileRegistrationIdNotFound}\n\n@endpoint DELETE /v3/ai/file-registrations/{fileRegistrationId}\n@desc Archives a registered file\n@required {fileRegistrationId: str}\n@returns(200) OK\n@returns(204) The file was successfully archived\n@errors {403: Not authorized, 404: The file registration id does not exist}\n\n@endpoint POST /v3/ai/image-generations/refine\n@desc Refine an image\n@required {prompt: str, mask_url: str}\n@optional {reference_asset_id: str, reference_generation: map{generation_request_id: str, index: int(int32)}, product_id: int(int32), project_code: str, notes: str}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to refine an image\n@errors {400: InvalidProduct, 403: Product quota exceeded, 404: Image not found, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/extend\n@desc Extend an image\n@optional {reference_asset_id: str, reference_generation: map{generation_request_id: str, index: int(int32)}, prompt: str, product_id: int(int32), project_code: str, notes: str, left_percentage: num(float), right_percentage: num(float), top_percentage: num(float), bottom_percentage: num(float)}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to extend an image\n@errors {400: InvalidProduct, 403: Product quota exceeded, 404: Image not found, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/background-removal\n@desc Remove a background\n@optional {reference_asset_id: str # Asset Id to modify., reference_generation: map{generation_request_id: str, index: int(int32)}, product_id: int(int32) # If you have multiple Getty products, indicate which one you would like to use for this refine request, project_code: str # The project code to use for the request.  Some products require this value., notes: str # The notes to use for the request.  Some products require this value.}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to extend an image\n@errors {400: The request was invalid, 403: Product quota exceeded, 404: Image not found, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/object-removal\n@desc Remove object(s)\n@optional {reference_asset_id: str # Asset Id to modify., reference_generation: map{generation_request_id: str, index: int(int32)}, product_id: int(int32) # If you have multiple Getty products, indicate which one you would like to use for this refine request, project_code: str # The project code to use for the request.  Some products require this value., notes: str # The notes to use for the request.  Some products require this value., mask_url: str # The location of the mask.}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to refine images\n@errors {400: InvalidProduct, 403: Product quota exceeded, 404: Either the generation id does not exist, the index is incorrect, or the generation is still pending, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/background-replacement\n@desc Replace the background of an existing image\n@optional {prompt: str, reference_asset_id: str, reference_generation: map{generation_request_id: str, index: int(int32)}, product_id: int(int32), media_type: str(photography/illustration), negative_prompt: str, background_color: str, project_code: str, notes: str}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to replace a background\n@errors {400: InvalidProduct, 403: NotAuthorized, 404: GenerationRequestIdNotFound, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/influence-color-by-image\n@desc Influence the color of generated images using a reference image\n@optional {reference_asset_id: str # Asset Id to modify., reference_generation: map{generation_request_id: str, index: int(int32)}, reference_file_registration_id: str # File Id to modify., prompt: str # This is the primary text used for refining the images., noise_level: num(float) # Accepted values are 0-1. Higher values will increase differences between the reference and generated images., media_type: str(photography/illustration), product_id: int(int32) # If you have multiple Getty products, indicate which one you would like to use for this refine request, project_code: str # The project code to use for the request.  Some products require this value., notes: str # The notes to use for the request.  Some products require this value.}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to extend an image\n@errors {400: The request was invalid, 403: Product quota exceeded, 404: Image not found, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/influence-composition-by-image\n@desc Influence the composition of generated images using a reference image\n@optional {reference_asset_id: str # Asset Id to modify., reference_generation: map{generation_request_id: str, index: int(int32)}, reference_file_registration_id: str # File Id to modify., prompt: str # This is the primary text used for refining the images., influence_level: num(float) # Accepted values are 0-1. Higher values will increase the similarities between the reference and generated images., media_type: str(photography/illustration), mood: str(black_and_white/warm/cool/natural/vivid/dramatic/bold), product_id: int(int32) # If you have multiple Getty products, indicate which one you would like to use for this refine request, project_code: str # The project code to use for the request.  Some products require this value., notes: str # The notes to use for the request.  Some products require this value.}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request to extend an image\n@errors {400: InvalidProduct, 403: Product quota exceeded, 404: Image not found, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: TooManyConcurrentGenerations}\n\n@endpoint POST /v3/ai/image-generations/background-generations\n@desc Add a background to a reference image\n@optional {reference_file_registration_id: str, prompt: str, product_id: int(int32), project_code: str, notes: str, left_percentage: num(float), right_percentage: num(float), top_percentage: num(float), bottom_percentage: num(float), background_file_registration_id: str, background_asset_id: str, background_reference_generation: map{generation_request_id: str, index: int(int32)}, background_reference_adherence: str(flexible/strong)}\n@returns(202) {generation_request_id: str?} # Returns the request ID for a pending request\n@errors {400: InvalidProduct, 403: Product quota exceeded, 404: Image not found, 409: ConcurrencyConflict, 429: TooManyConcurrentGenerations}\n\n@endpoint GET /v3/ai/generation-history\n@desc Retrieve history of AI generations\n@optional {date_start: str(date-time) # If included, limits the results to those generation requests made on or after date_start. Both dates and datetimes are supported.  Dates should be submitted in ISO 8601 format YYYY-MM-DD. The time will default to 00:00:00 UTC.  Datetimes should be submitted in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ., date_end: str(date-time) # If included, limits the results to those generation requests made on or before date_end. Both dates and datetimes are supported.  Dates should be submitted in ISO 8601 format YYYY-MM-DD. The time will default to 00:00:00 UTC.  Datetimes should be submitted in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ., media_type: str # If included, limits the results to those generation requests made for the given media type., page_size: int(int32) # The page size of results.  Default is 30., page: int(int32) # The page number of results.  Default is 1., product_ids: [int(int32)] # If included, limits the results to only those requests made against the indicated products., company_generations: bool=false # If `true`, returns the list of previously downloaded images for all users in             your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for             more information. Default is `false`.}\n@returns(200) {generations: [map]?, result_count: int(int32)} # Returns the history of AI generations\n@errors {403: Company generations were requested but your account is not configured for access., 409: ConcurrencyConflict}\n\n@endpoint GET /v3/ai/generation-history/{generationRequestId}\n@desc Retrieve history item for an individual generation request\n@required {generationRequestId: str # The ID from a previous request to generate images}\n@returns(200) {generation_request_id: str?, seed: int(int32)?, generation_date: str(date-time), product_revoked_date: str(date-time)?, prompt: str?, negative_prompt: str?, product_id: int(int32), notes: str?, project_code: str?, generation_type: str, generation_options: map{media_type: str, aspect_ratio: str?, mood: str}, source_generation_request: map{source_generation_request_id: str?, source_generation_result_index: int(int32)}, original_asset: map{id: str?}, results: [map]?, user: map{username: str?, first_name: str?, middle_name: str?, last_name: str?}} # Returns the history item for the request\n@errors {403: NotAuthorized, 404: The request ID was not found, 409: ConcurrencyConflict}\n\n@endpoint GET /v3/ai/image-generations/{generationRequestId}/images/{index}/download-sizes\n@desc Get download sizes for a generated image\n@required {generationRequestId: str # The ID from a previous request to generate images, index: int(int32) # The index of the image from the specific images generation}\n@returns(200) {download_sizes: [map]?} # Returns the result of a request\n@errors {400: InvalidProduct, 403: NotAuthorized, 404: Either the generation id does not exist, the index is incorrect, or the generation is still pending, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: DailyRequestLimitExceeded}\n\n@endpoint PUT /v3/ai/image-generations/{generationRequestId}/images/{index}/download\n@desc Begin the download process\n@required {generationRequestId: str # The ID from a previous request to generate images, index: int(int32) # The index of the image from the specific images generation}\n@optional {notes: str # The notes to use for the download request.  Some products require this value., project_code: str # The project code to use for the download request.  Some products require this value., size_name: str # The size name.  Valid values are 1k or 4k., product_id: int(int32) # The product id to download against. Only required when the customer has more than one agreement.}\n@returns(202) Download request was successful but is pending\n@errors {400: InvalidProduct, 403: NotAuthorized, 404: GenerationRequestIdNotFound, 409: A download is already in progress for the given `generationRequestId` and `index`., 410: GenerationRequestGone, 429: DailyRequestLimitExceeded}\n\n@endpoint GET /v3/ai/image-generations/{generationRequestId}/images/{index}/download\n@desc Once the download process has started, this endpoint can be used to check the status of the download and get the\n@required {generationRequestId: str # The ID from a previous request to generate images, index: int(int32) # The index of the image from the specific images generation}\n@returns(200) {url: str?, generated_asset_id: str?} # Download request was successful and is complete\n@returns(202) Download request was successful put is pending\n@errors {400: InvalidProduct, 403: NotAuthorized, 404: GenerationRequestIdNotFound, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: DailyRequestLimitExceeded}\n\n@endpoint POST /v3/ai/redownloads\n@desc Re-download a previously downloaded item\n@optional {generated_asset_id: str # The identifier of the previously-downloaded generated asset., product_id: int(int32) # The product ID to use for the download., size_name: str # The size name.  Valid values are 1k or 4k., project_code: str # The project code to use for the download request.  Some products require this value., notes: str # The notes to use for the download request.  Some products require this value.}\n@returns(200) {url: str?, generated_asset_id: str?} # Returns the re-download response\n@errors {400: The request was invalid, 403: Product is not active or quota exceeded, 404: Could not find source generated_asset_id, 409: ConcurrencyConflict, 410: GenerationRequestGone, 429: DailyRequestLimitExceeded}\n\n@endpoint POST /v3/ai/enhance-prompt\n@desc Expands and enriches a short prompt to produce a more detailed and descriptive prompt which can then be used to generate images.\n@required {prompt: str}\n@returns(200) {enhanced_prompt: str?} # OK\n@errors {400: PromptEnhancementFailed}\n\n@endgroup\n\n@group artists\n@endpoint GET /v3/artists/images\n@desc Search for images by a photographer\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., artist_name: str # Name of artist for desired images, fields: [str] # Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned., page: int(int32)=1 # Identifies page to return. Default page is 1., page_size: int(int32)=10 # Specifies page size. Default page_size is 10, maximum page_size is 100.}\n@returns(200) {images: [map]?, result_count: int(int32)} # OK\n@errors {400: InvalidParameterValue, 401: Unauthorized}\n\n@endpoint GET /v3/artists/videos\n@desc Search for videos by a photographer\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., artist_name: str # Name of artist for desired images, fields: [str] # Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned., page: int(int32)=1 # Identifies page to return. Default page is 1., page_size: int(int32)=10 # Specifies page size. Default page_size is 10, maximum page_size is 100.}\n@returns(200) {videos: [map]?, result_count: int(int32)} # OK\n@errors {400: InvalidParameterValue, 401: Unauthorized}\n\n@endgroup\n\n@group asset-changes\n@endpoint PUT /v3/asset-changes/change-sets\n@desc Get asset change notifications.\n@optional {channel_id: int(int32) # Specifies the id of the channel for the asset data. Valid channel ids can be found in the results of the Get Partner Channel query., batch_size: int(int32) # Specifies the number of assets to return. The default is 2200; maximum is 2200.}\n@returns(200) {change_set_id: str?, changed_assets: [map]?} # Success - Channel contains unconfirmed asset change notifications\n@returns(201) {change_set_id: str?, changed_assets: [map]?} # Created\n@errors {400: InvalidChannelIdException, 403: Your access token does not authorize access to this resource, 404: The channel you specified does not exist}\n\n@endpoint DELETE /v3/asset-changes/change-sets/{change-set-id}\n@desc Confirm asset change notifications.\n@required {change-set-id: int(int64) # Specify the change-set-id associated with a transaction resource whose receipt you want to confirm.}\n@returns(200) Success\n@errors {400: InvalidChangeSetId, 403: Your access token does not authorize access to this resource, 404: Transaction was not found}\n\n@endpoint GET /v3/asset-changes/channels\n@desc Get a list of asset change notification channels.\n@returns(200) OK\n@errors {403: UnauthorizedToAccessResource, 404: ChannelsNotFound}\n\n@endgroup\n\n@group asset-licensing\n@endpoint POST /v3/asset-licensing/{assetId}\n@desc Endpoint for acquiring extended licenses with iStock credits for an asset.\n@required {assetId: str # Getty Images assetId - examples 520621493, 112301284, extended_licenses: [str]}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., use_team_credits: bool # Defaults to false.}\n@returns(200) {credits_used: int(int32), acquired_licenses: [str]?} # OK\n@errors {400: InvalidRequestParameters, 401: AuthorizationTokenRequired, 402: NotEnoughCreditsForPurchase, 404: StandardLicenseNotFound}\n\n@endgroup\n\n@group boards\n@endpoint GET /v3/boards\n@desc Get all boards that the user participates in\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., page: int(int32)=1 # Request results starting at a page number (default is 1)., board_relationship: str # Search for boards the user owns or has been invited to as an editor., sort_order: str # Sort the list of boards by last update date or name. Defaults to date_last_updated_descending., pageSize: int(int32)=30 # Request number of boards to return in each page. (default is 30).}\n@returns(200) {boards: [map]?, board_count: int(int32)} # OK\n@errors {400: InvalidParameterValue, 401: Unauthorized}\n\n@endpoint POST /v3/boards\n@desc Create a new board\n@required {name: str}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., description: str}\n@returns(201) {id: str?} # Created\n@errors {400: InvalidParameterValue, 401: Unauthorized}\n\n@endpoint GET /v3/boards/{board_id}\n@desc Get assets and metadata for a specific board\n@required {board_id: str # Retrieve details for a specific board.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) {id: str?, asset_count: int(int32), assets: [map]?, date_created: str(date-time), date_last_updated: str(date-time), description: str?, name: str?, comment_count: int(int32), permissions: map{can_delete_board: bool, can_invite_to_board: bool, can_update_name: bool, can_update_description: bool, can_add_assets: bool, can_remove_assets: bool}, links: map{invitation: str?, share: str?}} # OK\n@errors {400: InvalidParameterValue, 401: Unauthorized, 404: BoardNotFound}\n\n@endpoint DELETE /v3/boards/{board_id}\n@desc Delete a board\n@required {board_id: str # Specifies the board to delete.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) OK\n@returns(204)\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint PUT /v3/boards/{board_id}\n@desc Update a board\n@required {board_id: str # Specifies the board to update., name: str}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., description: str}\n@returns(200) OK\n@returns(204) Updated\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint PUT /v3/boards/{board_id}/assets\n@desc Add assets to a board\n@required {board_id: str # Specifies the board to add assets to.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(201) {assets_added: [map]?, assets_not_added: [str]?} # Created\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint DELETE /v3/boards/{board_id}/assets\n@desc Remove assets from a board\n@required {board_id: str # Specifies the board to remove assets from.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., asset_ids: [str] # List the assets to be removed from the board.}\n@returns(200) OK\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint PUT /v3/boards/{board_id}/assets/{asset_id}\n@desc Add an asset to a board\n@required {board_id: str # Specifies the board to add an asset to., asset_id: str # Specifies the asset to add to the board. If it is already in the board's asset collection, no action is taken.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(201) Created\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: AssetNotFound, 404: BoardNotFound}\n\n@endpoint DELETE /v3/boards/{board_id}/assets/{asset_id}\n@desc Remove an asset from a board\n@required {board_id: str # Specifies the board to remove an asset from., asset_id: str # Specifies the asset to remove from the board.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) OK\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint POST /v3/boards/{board_id}/assets/{asset_id}/comments\n@desc Add a comment to an asset on the specified board.\n@required {board_id: str # Specifies the board containing the asset., asset_id: str # Specifies the asset to add the comment to.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., Text: str}\n@returns(200) {Id: str?} # OK\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint DELETE /v3/boards/{board_id}/assets/{asset_id}/comments/{comment_id}\n@desc Delete a comment from an asset on the specified board.\n@required {board_id: str # Specifies the board containing the asset., asset_id: str # Specifies the asset containing the comment., comment_id: str # Specifies the comment to delete.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) OK\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint GET /v3/boards/{board_id}/comments\n@desc Get comments from a board\n@required {board_id: str # Specifies the board to retrieve comments from.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) {comments: [map]?, permissions: map{can_add_comment: bool}} # OK\n@errors {400: InvalidParameterValue, 401: Unauthorized, 404: BoardNotFound}\n\n@endpoint POST /v3/boards/{board_id}/comments\n@desc Add a comment to a board\n@required {board_id: str # Specifies the board to add a comment to.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., text: str}\n@returns(201) {id: str?} # Created\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endpoint DELETE /v3/boards/{board_id}/comments/{comment_id}\n@desc Delete a comment from a board\n@required {board_id: str # Specifies the board containing the comment to delete., comment_id: str # Specifies the comment to delete.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) OK\n@returns(204) CommentDeleted\n@errors {400: InvalidParameterValue, 401: Unauthorized, 403: InsufficientAccess, 404: BoardNotFound}\n\n@endgroup\n\n@group collections\n@endpoint GET /v3/collections\n@desc Gets collections applicable for the customer.\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) {collections: [map]?} # OK\n@errors {401: Unauthorized}\n\n@endgroup\n\n@group countries\n@endpoint GET /v3/countries\n@desc Gets countries codes and names.\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) {countries: [map]?} # OK\n@errors {401: Unauthorized}\n\n@endgroup\n\n@group customers\n@endpoint GET /v3/customers/current\n@desc Returns information about the current user.\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) {first_name: str?, middle_name: str?, last_name: str?} # OK\n@errors {400: InvalidRequestParameters, 401: Unauthorized, 503: ServiceUnavailable}\n\n@endgroup\n\n@group downloads\n@endpoint GET /v3/downloads\n@desc Returns information about a customer's downloaded assets.\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., date_from: str(date-time) # If specified, selects assets downloaded on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).  Any hour, minute, second values in the request are not used, unless useTimePart parameter is included. Date/times in the response are UTC. Default is 30 days prior to date_to, date_to: str(date-time) # If specified, selects assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD) Any hour, minute, second values in the request are not used, unless useTimePart parameter is included. Date/times in the response are UTC. Default is current date or 30 days after specified start date, whichever one is earlier., use_time: bool=false # If specified, time values provided with date_to or date_from will be used. Time values should be appended to the date value in ISO 8601 format i.e.: 2019-09-19T19:30:37 or 2019-09-19 19:30:37.  Time zone can be specified as optional. Default value is false, page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=30 # Specifies page size. Default is 30, maximum page_size is 100., product_type: str # Specifies product type to be included in the previous download results. Product types easyaccess, editorialsubscription, imagepack, and premiumaccess are for GettyImages API keys. Product types royaltyfreesubscription and creditpack are for iStock API keys. To get previous iStockPhoto credit downloads, creditpack must be selected., company_downloads: bool=false # If specified, returns the list of previously downloaded images for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.}\n@returns(200) {result_count: int(int32), downloads: [map]?} # OK\n@errors {400: Bad request, 401: AuthorizationTokenRequired, 403: Forbidden}\n\n@endpoint POST /v3/downloads/images/{id}\n@desc Download an image\n@required {id: str # Id of image to download.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., auto_download: bool=true # Specifies whether to auto-download the image. If true is specified, a 303 SeeOther status is returned with a                     Location header set to the location of the image.                     If false is specified, the download URI will be returned in the response message. Default is true., file_type: str # File Type expressed with three character file extension., height: str # Specifies the pixel height of the particular image to download.                     Available heights can be found in the images/{ids} response for the specific image.                     If left blank, it will return the largest available size., product_id: int(int32) # Identifier of the instance for the selected product offering type., product_type: str # Product types easyaccess, editorialsubscription, imagepack, and premiumaccess are for GettyImages API keys. Product types royaltyfreesubscription and creditpack are for iStock API keys. Default product type for iStock API keys is creditpack., use_team_credits: bool=false # Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False., download_notes: str, project_code: str}\n@returns(200) OK\n@errors {303: See Other, 400: MissingRequiredQueryParameters, 401: AuthorizationTokenRequired, 403: OverageLimitReached, 404: ImageNotFound}\n\n@endpoint POST /v3/downloads/videos/{id}\n@desc Download a video\n@required {id: str # Id of video to download.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., auto_download: bool=false # Specifies whether to auto-download the video. If true is specified, a 303 SeeOther status is returned with a                     Location header set to the location of the video.                     If false is specified, the download URI will be returned in the response message. Default is false., size: str # Specifies the size to be downloaded., product_id: int(int32) # Identifier of the instance for the selected product offering type., product_type: str # Product types easyaccess, editorialsubscription, imagepack, and premiumaccess are for GettyImages API keys. Product types royaltyfreesubscription and creditpack are for iStock API keys. Default product type for iStock API keys is creditpack., use_team_credits: bool # Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False., download_notes: str, project_code: str}\n@returns(200) OK\n@errors {303: See Other, 400: MissingRequiredQueryParameters, 401: AuthorizationTokenRequired, 403: OverageLimitReached, 404: VideoNotFound}\n\n@endgroup\n\n@group events\n@endpoint GET /v3/events\n@desc Get metadata for multiple events\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., ids: [int(int32)] # A comma separated list of event ids., fields: [str] # A comma separated list of fields to return in the response.}\n@returns(200) {events: [map]?, events_not_found: [int(int32)]?} # OK\n@errors {400: InvalidRequestParameters, 401: Unauthorized, 404: EventNotFound}\n\n@endpoint GET /v3/events/{id}\n@desc Get metadata for a single event\n@required {id: int(int32) # An event id.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # A comma separated list of fields to return in the response.}\n@returns(200) {child_event_count: int(int32)?, child_events: [map]?, editorial_segments: [str]?, hero_image: map{id: str?, display_sizes: [map]?}, id: int(int32), image_count: int(int32)?, keywords: [map]?, location: map{city: str?, country: str?, state_province: str?, venue: str?}, name: str?, start_date: str(date-time)?, type: str?} # OK\n@errors {400: InvalidRequestParameters, 401: Unauthorized, 404: EventNotFound}\n\n@endgroup\n\n@group image-match\n@endpoint GET /v3/image-match/search\n@desc Searches for image matches using the provided URL.\n@required {url: str # The URL of the image to search for.}\n@returns(200) {id: str?} # OK\n@errors {400: InvalidImageUrl, 404: Not Found}\n\n@endgroup\n\n@group images\n@endpoint GET /v3/images\n@desc Get metadata for multiple images by supplying multiple image ids\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., ids: [str] # Specifies one or more image ids to return. Use comma delimiter when requesting multiple ids.  Maximum of 100 ids., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates.}\n@returns(200) {images: [map]?, images_not_found: [str]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: ImageNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/images/{id}\n@desc Get metadata for a single image by supplying one image id\n@required {id: str # An image id. For more than one image please use the /v3/images endpoint.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates.}\n@returns(200) {images: [map]?, images_not_found: [str]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: ImageNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/images/{id}/downloadhistory\n@desc Returns information about a customer's download history for a specific asset\n@required {id: str # An image id.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., company_downloads: bool # If specified, returns the list of previously downloaded images for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.}\n@returns(200) {id: str?, downloads: [map]?} # OK\n@errors {400: Bad request, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: ImageNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/images/{id}/same-series\n@desc Retrieve creative images from the same series\n@required {id: str # Identifies an existing image}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates., page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=30 # Specifies page size. Default is 30, maximum page_size is 100.}\n@returns(200) {result_count: int(int32), images: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, auto_corrections: map{phrase: str?}, related_searches: [map]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: ImageNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/images/{id}/similar\n@desc Retrieve similar images\n@required {id: str # Identifies an existing image}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates., page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=30 # Specifies page size. Default is 30, maximum page_size is 100.}\n@returns(200) {result_count: int(int32), images: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, auto_corrections: map{phrase: str?}, related_searches: [map]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: ImageNotFound, 500: InvalidIStockCollection}\n\n@endgroup\n\n@group orders\n@endpoint GET /v3/orders/{id}\n@desc Get order metadata\n@required {id: str # An order id.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only).}\n@returns(200) {id: str?, invoice_number: str?, order_date: str(date-time), end_client: str?, notes: map{licensee_name: str?, purchase_order_number: str?, project_title: str?, ordered_by: str?}, assets: [map]?} # OK\n@errors {401: Unauthorized, 403: NoAccessToOrderMetadata, 404: OrderNotFound}\n\n@endgroup\n\n@group products\n@endpoint GET /v3/products\n@desc Get Products\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # Comma separated list of fields. Allows product download requirements to be returned.}\n@returns(200) {products: [map]?} # OK\n@errors {400: InvalidRequestParameters, 401: Unauthorized, 500: CreditPack}\n\n@endgroup\n\n@group purchased-assets\n@endpoint GET /v3/purchased-assets\n@desc Get Previously Purchased Images and Video\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., date_to: str(date-time) # If specified, retrieves previous purchases on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD)., page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=75 # Specifies page size. Default is 75, maximum page_size is 100., date_from: str(date-time) # If specified, retrieves previous purchases on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD)., company_purchases: bool=false # If specified, returns the list of previously purchased assets for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.}\n@returns(200) {result_count: int(int32), previous_purchases: [map]?} # OK\n@errors {400: PageNumberLessThanOne, 401: Unauthorized, 403: InsufficientPermissions}\n\n@endgroup\n\n@group search\n@endpoint GET /v3/search/events\n@desc Search for events\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., editorial_segment: str # Filters to events with a matching editorial segment., date_from: str(date-time) # Filters to events that start on or after this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified., date_to: str(date-time) # Filters to events that start on or before this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified., fields: [str] # Specifies fields to return. Default set is 'id','name','start_date'., page: int(int32)=1 # Request results starting at a page number (default is 1, maximum is 50)., page_size: int(int32)=30 # Request number of events to return in each page. Default is 30, maximum page_size is 100., phrase: str= # Filters to events related to this phrase, sort_order: str # Specifies the order in which to sort the results. Default is `newest`.}\n@returns(200) {events: [map]?, result_count: int(int32)} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize}\n\n@endpoint GET /v3/search/images/creative\n@desc Search for creative images only\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., age_of_people: [str] # Filter based on the age of individuals in an image., artists: str # Search for images by specific artists (free-text, comma-separated list of artists)., collection_codes: [str] # Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type., collections_filter_type: str # Use to include or exclude collections from search. The default is include, color: str # Filter based on predominant color in an image. Use 6 character hexadecimal format (e.g., #002244)., compositions: [str] # Filter based on image composition., download_product: str # Filters based on which product the asset will download against.                     Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.                     If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on.                      For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234.                      Product ID can be obtained from the GET /products response., embed_content_only: bool=false # Restrict search results to embeddable images. The default is false., enhanced_search: bool=true # If set to `false`, your search will not use enhanced search. Defaults to `true`., ethnicity: [str] # Filter search results based on the ethnicity of individuals in an image., exclude_editorial_use_only: bool # Exclude images that are only available for editorial (non-commercial) use. Default value is false., exclude_keyword_ids: [int(int32)] # Return only images not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also do not contain the requested keyword(s) are returned., exclude_nudity: bool=false # Excludes images containing nudity. The default is false., facet_fields: [str] # Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.                    The include_facets parameter must be set to \"true\" for facets to be returned., facet_max_count: int(int32)=300 # Specifies the maximum number of facets to return per type. Default is 300., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates., file_types: [str] # Return only images having a specific file type., graphical_styles: [str] # Filter based on graphical style of the image., graphical_styles_filter_type: str # Provides searching based on specified graphical style(s). The default is include., include_facets: bool # Specifies whether or not to include facets in the result set. Default is \"false\"., include_related_searches: bool=false # Specifies whether or not to include related searches in the response. The default is false., keyword_ids: [int(int32)] # Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned., minimum_size: str # Filter based on minimum size requested. The default is x-small., moods: [str] # Filter based on predominant mood in an image., number_of_people: [str] # Filter based on the number of people in the image., orientations: [str] # Return only images with selected aspect ratios., page: int(int32)=1 # Request results starting at a page number (default is 1)., page_size: int(int32)=30 # Request number of images to return in each page. Default is 30, maximum page_size is 100., phrase: str= # Search images using a search phrase., safe_search: bool=false # Setting safe_search to \"true\" excludes images containing nudity, death, profanity, drugs and alcohol, suggestive content, and graphic content from the result set. The default is false. Because this is a keyword-based filter, it's possible that a small number of unsafe images may not be caught by the filter. Please direct feedback to your Getty Images Account or API support representative., sort_order: str # Select sort order of results.  The default is best_match}\n@returns(200) {result_count: int(int32), images: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, auto_corrections: map{phrase: str?}, related_searches: [map]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/search/images/creative/by-image\n@desc Search for creative images based on url\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., asset_id: str # Specifies the Getty image id to use in the search., exclude_editorial_use_only: bool # Exclude images that are only available for editorial (non-commercial) use. Default value is false., facet_fields: [str] # Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.                     The include_facets parameter must be set to \"true\" for facets to be returned., facet_max_count: int(int32)=300 # Specifies the maximum number of facets to return per type. Default is 300., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates., image_url: str # Specifies the location of the image to use in the search., include_facets: bool # Specifies whether or not to include facets in the result set. Default is \"false\"., page: int(int32)=1 # Request results starting at a page number (default is 1)., page_size: int(int32)=30 # Request number of images to return in each page. Default is 30, maximum page_size is 100., phrase: str= # Free-text search query., product_types: [str] # Filter images to those from one of your product types.                      Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription.                      If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on.                      For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234.                      Product ID can be obtained from the GET /products response.}\n@returns(200) {image_fingerprint: str?, related_searches: [map]?, result_count: int(int32), images: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, auto_corrections: map{phrase: str?}} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: AssetNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/search/images/editorial\n@desc Search for editorial images only\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., age_of_people: [str] # Filter based on the age of individuals in an image., artists: str # Search for images by specific artists (free-text, comma-separated list of artists)., collection_codes: [str] # Filter by collections (comma-separated list of collection codes). Include or exclude based on collections_filter_type., collections_filter_type: str # Use to include or exclude collections from search. The default is include, compositions: [str] # Filter based on image composition., date_from: str(date-time) # Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31)., date_to: str(date-time) # Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31)., download_product: str # Filters based on which product the asset will download against.                     Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.                     If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on.                      For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234.                      Product ID can be obtained from the GET /products response., editorial_segments: [str] # Return only events with a matching editorial segment., embed_content_only: bool=false # Restrict search results to embeddable images. The default is false., ethnicity: [str] # Filter search results based on the ethnicity of individuals in an image., event_ids: [int(int32)] # Filter based on specific events, exclude_keyword_ids: [int(int32)] # Return only images not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also do not contain the requested keyword(s) are returned., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates., file_types: [str] # Return only images having a specific file type., graphical_styles: [str] # Filter based on graphical style of the image., graphical_styles_filter_type: str # Provides searching based on specified graphical style(s). The default is include., include_related_searches: bool=false # Specifies whether or not to include related searches in the response. The default is false., keyword_ids: [int(int32)] # Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned., minimum_size: str # Filter based on minimum size requested. The default is x-small., number_of_people: [str] # Filter based on the number of people in the image., orientations: [str] # Return only images with selected aspect ratios., page: int(int32)=1 # Request results starting at a page number (default is 1)., page_size: int(int32)=30 # Request number of images to return in each page. Default is 30, maximum page_size is 100., phrase: str # Search images using a search phrase., sort_order: str # Select sort order of results.  The default is best_match, specific_people: [str] # Return only images associated with specific people (using a comma-delimited list)., minimum_quality_rank: int(int32) # Filter search results based on minimum quality ranking. Possible values 1, 2, 3 with 1 being best., facet_fields: [str] # Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.                    The include_facets parameter must be set to \"true\" for facets to be returned., include_facets: bool # Specifies whether or not to include facets in the result set. Default is \"false\"., facet_max_count: int(int32)=300 # Specifies the maximum number of facets to return per type. Default is 300.}\n@returns(200) {result_count: int(int32), images: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, auto_corrections: map{phrase: str?}, related_searches: [map]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize}\n\n@endpoint GET /v3/search/videos/creative\n@desc Search for creative videos\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., age_of_people: [str] # Provides filtering according to the age of individuals in a video., artists: str # Search for videos by specific artists (free-text, comma-separated list of artists)., aspect_ratios: [str] # Search for videos by specific aspect ratios., collection_codes: [str] # Provides filtering by collection code., collections_filter_type: str # Use to include or exclude collections from search. The default is include, compositions: [str] # Filter based on video composition., download_product: str # Filters based on which product the asset will download against.                     Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.                     If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on.                      For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234.                      Product ID can be obtained from the GET /products response., enhanced_search: bool=true # If set to `false`, your search will not use enhanced search. Defaults to `true`., ethnicity: [str] # Filter search results based on the ethnicity of individuals., exclude_editorial_use_only: bool # Exclude videos that are only available for editorial (non-commercial) use. Default value is false., exclude_keyword_ids: [int(int32)] # Return only videos not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also do not contain the requested keyword(s) are returned., exclude_nudity: bool=false # Excludes videos containing nudity. The default is false., facet_fields: [str] # Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.                    The include_facets parameter must be set to \"true\" for facets to be returned., facet_max_count: int(int32)=300 # Specifies the maximum number of facets to return per type. Default is 300., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate., format_available: str # Filters according to the digital video format available on a film asset., frame_rates: [str] # Provides filtering by video frame rate (frames/second)., image_techniques: [str] # Filter based on image technique., include_facets: bool # Specifies whether or not to include facets in the result set. Default is \"false\"., include_related_searches: bool=false # Specifies whether or not to include related searches in the response. The default is false., keyword_ids: [int(int32)] # Return only videos tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also contain the requested keyword(s) are returned., license_models: [str] # Specifies the video licensing model(s)., min_clip_length: int(int32)=0 # Provides filtering by minimum length of video clip, in seconds, max_clip_length: int(int32)=0 # Provides filtering by maximum length of video, in seconds, number_of_people: [str] # Filter based on the number of people., orientations: [str] # Return only videos with selected orientations., page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=30 # Specifies page size. Default is 30, maximum page_size is 100., phrase: str= # Free-text search query., safe_search: bool=false # Setting safe_search to \"true\" excludes images containing nudity, death, profanity, drugs and alcohol, suggestive content, and graphic content from the result set. The default is false. Because this is a keyword-based filter, it's possible that a small number of unsafe images may not be caught by the filter. Please direct feedback to your Getty Images Account or API support representative., sort_order: str # Select sort order of results.  The default is best_match, release_status: str # Allows filtering by type of model release., viewpoints: [str] # Filter based on viewpoint.}\n@returns(200) {videos: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, related_searches: [map]?, result_count: int(int32), auto_corrections: map{phrase: str?}} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/search/videos/creative/by-image\n@desc Search for creative videos based on url\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., asset_id: str # Specifies the Getty video id to use in the search., exclude_editorial_use_only: bool # Exclude videos that are only available for editorial (non-commercial) use. Default value is false., facet_fields: [str] # Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.                     The include_facets parameter must be set to \"true\" for facets to be returned., facet_max_count: int(int32)=300 # Specifies the maximum number of facets to return per type. Default is 300., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate., image_url: str # Specifies the location of the image to use in the search., include_facets: bool # Specifies whether or not to include facets in the result set. Default is \"false\"., page: int(int32)=1 # Request results starting at a page number (default is 1)., page_size: int(int32)=30 # Request number of images to return in each page. Default is 30, maximum page_size is 100., phrase: str= # Free-text search query., product_types: [str] # Filter images to those from one of your product types.                      Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription.                      If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on.                      For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234.                      Product ID can be obtained from the GET /products response.}\n@returns(200) {related_searches: [map]?, videos: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, result_count: int(int32), auto_corrections: map{phrase: str?}} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: AssetNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/search/videos/editorial\n@desc Search for editorial videos\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., age_of_people: [str] # Provides filtering according to the age of individuals in a video., artists: str # Search for videos by specific artists (free-text, comma-separated list of artists)., aspect_ratios: [str] # Search for videos by specific aspect ratios., collection_codes: [str] # Provides filtering by collection code., collections_filter_type: str # Use to include or exclude collections from search. The default is include, compositions: [str] # Filter based on video composition., date_from: str(date-time) # Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31)., date_to: str(date-time) # Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31)., download_product: str # Filters based on which product the asset will download against.                     Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.                     If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on.                      For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234.                      Product ID can be obtained from the GET /products response., editorial_video_types: [str] # Allows filtering by types of video., event_ids: [int(int32)] # Filter based on specific events, fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate., format_available: str # Filters according to the digital video format available on a film asset., frame_rates: [str] # Provides filtering by video frame rate (frames/second)., image_techniques: [str] # Filter based on image technique., include_related_searches: bool=false # Specifies whether or not to include related searches in the response. The default is false., keyword_ids: [int(int32)] # Return only videos tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also contain the requested keyword(s) are returned., min_clip_length: int(int32)=0 # Provides filtering by minimum length of video clip, in seconds, max_clip_length: int(int32)=0 # Provides filtering by maximum length of video clip, in seconds, orientations: [str] # Return only videos with selected orientations., page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=30 # Specifies page size. Default is 30, maximum page_size is 100., phrase: str= # Free-text search query., sort_order: str # Select sort order of results.  The default is best_match, specific_people: [str] # Allows filtering by specific peoples' names., release_status: str # Allows filtering by type of model release., facet_fields: [str] # Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.                    The include_facets parameter must be set to \"true\" for facets to be returned., include_facets: bool # Specifies whether or not to include facets in the result set. Default is \"false\"., facet_max_count: int(int32)=300 # Specifies the maximum number of facets to return per type. Default is 300., viewpoints: [str] # Filter based on viewpoint.}\n@returns(200) {videos: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, related_searches: [map]?, result_count: int(int32), auto_corrections: map{phrase: str?}} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize}\n\n@endpoint PUT /v3/search/by-image/uploads/{file-name}\n@desc Upload image for use by the search creative images/videos operations\n@required {file-name: str}\n@returns(200) OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize}\n\n@endpoint GET /v3/search/images\n@desc Search for both creative and editorial images - *** DEPRECATED ***\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., GI-Country-Code: str # Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes., age_of_people: [str] # Filter based on the age of individuals in an image., artists: str # Search for images by specific artists (free-text, comma-separated list of artists)., collection_codes: [str] # Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type., collections_filter_type: str # Provides searching based on specified collection(s). The default is Include, color: str # Filter based on predominant color in an image. Use 6 character hexidecimal format (e.g., #002244). Note: when specified, results will not contain editorial images., compositions: [str] # Filter based on image composition., download_product: str # Filters based on which product the asset will download against.                     Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.                     If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on.                      For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234.                      Product ID can be obtained from the GET /products response., embed_content_only: bool=false # Restrict search results to embeddable images. The default is false., event_ids: [int(int32)] # Filter based on specific events, ethnicity: [str] # Filter search results based on the ethnicity of individuals in an image., fields: [str] # Specifies fields to return. Defaults to 'summary_set'., file_types: [str] # Return only images having a specific file type., graphical_styles: [str] # Filter based on graphical style of the image., graphical_styles_filter_type: str # Provides searching based on specified graphical style(s). The default is Include, include_related_searches: bool=false # Specifies whether or not to include related searches in the response. The default is false., keyword_ids: [int(int32)] # Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned., minimum_size: str # Filter based on minimum size requested. The default is x-small, number_of_people: [str] # Filter based on the number of people in the image., orientations: [str] # Return only images with selected aspect ratios., page: int(int32)=1 # Request results starting at a page number (default is 1)., page_size: int(int32)=30 # Request number of images to return in each page. Default is 30, maximum page_size is 100., phrase: str # Search images using a search phrase., sort_order: str # Select sort order of results.  The default is best_match, specific_people: [str] # Return only images associated with specific people (using a comma-delimited list).}\n@returns(200) {result_count: int(int32), images: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, auto_corrections: map{phrase: str?}, related_searches: [map]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize}\n\n@endgroup\n\n@group usage-batches\n@endpoint PUT /v3/usage-batches/{id}\n@desc Report usage of assets via a batch format.\n@required {id: str # Specifies a unique batch transaction id to identify the report.}\n@optional {asset_usages: [map{asset_id: str, quantity: int(int32), usage_date: str(date-time)}] # Identifies the list of asset id, usage count and date of usage combinations to record.}\n@returns(201) {invalid_assets: [str]?, total_asset_usages_processed: int(int32)?} # Success - All usages reported were successfully recorded.\n@errors {400: InvalidRequest - The content of the request was invalid. Most commonly this is due to either too many assets specified, no assets or invalid JSON., 401: AuthorizationTokenRequired - Authorization token was missing or not valid., 403: UnauthorizedToReportUsage, 409: TransactionIdDuplicated}\n\n@endgroup\n\n@group videos\n@endpoint GET /v3/videos\n@desc Get metadata for multiple videos by supplying multiple video ids\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., ids: [str] # Specifies one or more video ids to return. Use comma delimiter when requesting multiple ids.  Maximum of 100 ids., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate.}\n@returns(200) {videos: [map]?, videos_not_found: [str]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: VideosNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/videos/{id}\n@desc Get metadata for a single video by supplying one video id\n@required {id: str # A video id. For more than one video please use the /v3/video endpoint.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate.}\n@returns(200) {id: str?, allowed_use: map{how_can_i_use_it: str?, release_info: str?, usage_restrictions: [str]?, editorial_use_only: bool}, artist: str?, asset_family: str?, caption: str?, city: str?, clip_length: str?, collection_id: int(int32)?, collection_code: str?, collection_name: str?, color_type: str?, copyright: str?, country: str?, date_created: str(date-time)?, date_submitted: str(date-time)?, download_product: str?, display_sizes: [map]?, download_sizes: [map]?, editorial_segments: [str]?, era: str?, event_ids: [int(int32)]?, is_ai_editable: bool?, key_frames: [map]?, keywords: [map]?, license_model: str?, mastered_to: str?, originally_shot_on: str?, product_types: [str]?, quality_rank: int(int32)?, referral_destinations: [map]?, shot_speed: str?, source: str?, state_province: str?, title: str?, istock_licenses: [map]?, alternative_ids: map?, call_for_image: bool?, istock_sub_collection: str?, istock_collection: str?, max_dimensions: map{height: int(int32), width: int(int32)}, object_name: str?, orientation: str?, people: [str]?} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: VideosNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/videos/{id}/downloadhistory\n@desc Returns information about a customer's download history for a specific asset\n@required {id: str # A video id.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., company_downloads: bool # If specified, returns the list of previously downloaded videos for all users in your company.             Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.}\n@returns(200) {id: str?, downloads: [map]?} # OK\n@errors {400: Bad request, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: VideosNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/videos/{id}/same-series\n@desc Retrieve creative videos from the same series\n@required {id: str # Identifies an existing video}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate., page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=30 # Specifies page size. Default is 30, maximum page_size is 100.}\n@returns(200) {videos: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, related_searches: [map]?, result_count: int(int32), auto_corrections: map{phrase: str?}} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: VideosNotFound, 500: InvalidIStockCollection}\n\n@endpoint GET /v3/videos/{id}/similar\n@desc Retrieve similar videos\n@required {id: str # A video id.}\n@optional {Accept-Language: str # Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)., fields: [str] # Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate., page: int(int32)=1 # Identifies page to return. Default is 1., page_size: int(int32)=30 # Specifies page size. Default is 30, maximum page_size is 100.}\n@returns(200) {videos: [map]?, facets: map{specific_people: [map]?, events: [map]?, locations: [map]?, artists: [map]?, entertainment: [map]?}, related_searches: [map]?, result_count: int(int32), auto_corrections: map{phrase: str?}} # OK\n@errors {400: InvalidParameterValue, 401: AuthorizationTokenRequired, 403: UnauthorizedDisplaySize, 404: VideosNotFound, 500: InvalidIStockCollection}\n\n@endgroup\n\n@end\n"}