openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 208 kB
JSON
{"openapi":"3.0.0","info":{"description":"Build applications using the world's most powerful imagery","title":"Getty Images","version":"3","x-apisguru-categories":["media"],"x-logo":{"url":"http://developers.gettyimages.com/images/getty-api-logo.jpg"},"x-origin":[{"format":"swagger","url":"https://api.gettyimages.com/swagger/docs/3","version":"2.0"}],"x-providerName":"gettyimages.com"},"security":[{"Api-Key":[]}],"paths":{"/v3/artists/images":{"get":{"deprecated":false,"operationId":"Artists_GetImagesByArtist","parameters":[{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":false,"schema":{"type":"string"}},{"description":"Name of artist for desired images","in":"query","name":"artist_name","required":true,"schema":{"type":"string"}},{"description":"Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.","in":"query","name":"fields","required":false,"explode":true,"schema":{"type":"array","items":{"enum":["id","alternative_ids","asset_family","asset_type","caption","collection_code","collection_name","comp","date_submitted","keywords","license_model","max_dimensions","title"],"type":"string"}}},{"description":"Identifies page to return. Default page is 1.","in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Specifies page size. Default page_size is 10, maximum page_size is 100.","in":"query","name":"page_size","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Artists.ImageSearchResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Artists.ImageSearchResults"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"}},"summary":"Search for images by a photographer","tags":["Artists"]}},"/v3/artists/videos":{"get":{"deprecated":false,"operationId":"Artists_GetVideosByArtist","parameters":[{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":false,"schema":{"type":"string"}},{"description":"Name of artist for desired images","in":"query","name":"artist_name","required":true,"schema":{"type":"string"}},{"description":"Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.","in":"query","name":"fields","required":false,"explode":true,"schema":{"type":"array","items":{"enum":["id","alternative_ids","asset_family","asset_type","caption","collection_code","collection_name","comp","date_submitted","keywords","license_model","title"],"type":"string"}}},{"description":"Identifies page to return. Default page is 1.","in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Specifies page size. Default page_size is 10, maximum page_size is 100.","in":"query","name":"page_size","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Artists.VideoSearchResults"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Artists.VideoSearchResults"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"}},"summary":"Search for videos by a photographer","tags":["Artists"]}},"/v3/asset-changes/change-sets":{"put":{"deprecated":false,"description":"# Asset Changes\r\n\r\nGet notifications about new, updated or deleted assets.\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n \r\nPartner channels that have not been checked within the last 120 days will be removed and that partner will no longer be able \r\nto get change notifications from that channel.\r\nPartners who would like to start using the Asset Changes API again after a period of dormancy should contact their sales\r\nrepresentative to be set up again.\r\n","operationId":"AssetChanges_PutAssetChanges","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"channel_id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Specifies the number of assets to return. The default is 10; maximum is 500.","in":"query","name":"batch_size","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetChanges"}},"text/json":{"schema":{"$ref":"#/components/schemas/AssetChanges"}}}},"403":{"description":"Your access token does not authorize access to this resource"},"404":{"description":"The channel you specified does not exist"}},"summary":"Get asset change notifications.","tags":["AssetChanges"]}},"/v3/asset-changes/change-sets/{change-set-id}":{"delete":{"deprecated":false,"description":"# Delete Asset Changes\r\n\r\nConfirm asset changes acknowledges receipt of asset changes (from the PUT asset changes endpoint).\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n","operationId":"AssetChanges_DeleteAssetChanges","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"in":"path","name":"change-set-id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"},"403":{"description":"Your access token does not authorize access to this resource"},"404":{"description":"Transaction was not found"}},"summary":"Confirm asset change notifications.","tags":["AssetChanges"]}},"/v3/asset-changes/channels":{"get":{"deprecated":false,"description":"# Get Partner Channels\r\n\r\nRetrieves the channel data for the partner. This data can be used to populate the channel_id parameter in the Put Asset Changes query.\r\n\r\n## Quickstart\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\nOnly channels that have been queried in the last 120 days will be included in the list of channels.\r\nPartners who have a channel that has been removed should contact their sales representative to be set up again.\r\n\r\n","operationId":"AssetChanges_GetPartnerChannel","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerChannelList"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartnerChannelList"}}}},"404":{"description":"ChannelsNotFound"}},"summary":"Get a list of asset change notification channels.","tags":["AssetChanges"]}},"/v3/asset-licensing/{assetId}":{"post":{"deprecated":false,"operationId":"AssetLicensing_AcquireAssetLicenseWithCredits","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"Getty Images assetId - examples 520621493, 112301284","in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Controllers.AssetLicensing.AcquireAssetLicensesRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Controllers.AssetLicensing.AcquireAssetLicensesRequest"}}},"description":"Structure that specifies an array of LicenseTypes (Multiseat, Unlimited, Resale, Indemnification) to acquire,\r\n and whether or not to use Team Credits. Authenticated User must have access to Team Credits if UseTeamCredits is set to \"true\".","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Controllers.AssetLicensing.AssetLicensingResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Controllers.AssetLicensing.AssetLicensingResponse"}}}},"400":{"description":"InvalidRequest"},"401":{"description":"AuthorizationTokenRequired"},"402":{"description":"NotEnoughCreditsForPurchase"},"404":{"description":"StandardLicenseNotFound"}},"summary":"Endpoint for acquiring extended licenses with iStock credits for an asset.","tags":["AssetLicensing"]}},"/v3/boards":{"get":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve all Boards available for a user.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n","operationId":"Boards_GetAllBoards","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"Search for boards the user owns or has been invited to as an editor.","in":"query","name":"board_relationship","required":false,"schema":{"type":"string","enum":["owned","invited"]}},{"description":"Request results starting at a page number (default is 1).","in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Request number of boards to return in each page. (default is 30).","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Sort the list of boards by last update date or name. Defaults to date_last_updated_descending.","in":"query","name":"sort_order","required":false,"schema":{"type":"string","enum":["date_last_updated_descending","date_last_updated_ascending","name_ascending","name_decending"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoardList"}},"text/json":{"schema":{"$ref":"#/components/schemas/BoardList"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"}},"summary":"Get all boards that the user participates in","tags":["Boards"]},"post":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to create a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\n**NOTE:** *The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.*\r\n","operationId":"Boards_CreateBoard","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoardInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/BoardInfo"}}},"description":"Specify a name and description of the board to create (name is required).","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoardCreated"}},"text/json":{"schema":{"$ref":"#/components/schemas/BoardCreated"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"}},"summary":"Create a new board","tags":["Boards"]}},"/v3/boards/{board_id}":{"delete":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to delete a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\n","operationId":"Boards_DeleteBoard","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"InsufficientAccess"},"404":{"description":"BoardNotFound"}},"summary":"Delete a board","tags":["Boards"]},"get":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n","operationId":"Boards_GetBoard","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoardDetail"}},"text/json":{"schema":{"$ref":"#/components/schemas/BoardDetail"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"404":{"description":"BoardNotFound"}},"summary":"Get assets and metadata for a specific board","tags":["Boards"]},"put":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to update a Board by a specific id.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n\r\n**NOTE:** *The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.*\r\n","operationId":"Boards_UpdateBoard","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BoardInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/BoardInfo"}}},"description":"Specify a new name and description for the board (name is required).","required":true},"responses":{"204":{"description":"Updated"},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"InsufficientAccess"},"404":{"description":"BoardNotFound"}},"summary":"Update a board","tags":["Boards"]}},"/v3/boards/{board_id}/assets":{"delete":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to remove a set of assets from a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n","operationId":"Boards_RemoveAssets","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}},{"description":"List the assets to be removed from the board.","in":"query","name":"asset_ids","required":true,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"No Content"},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"InsufficientAccess"},"404":{"description":"BoardNotFound"}},"summary":"Remove assets from a board","tags":["Boards"]},"put":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to add a set of assets to a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\t\r\n\t\r\n","operationId":"Boards_AddAssets","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BoardAsset"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/BoardAsset"},"type":"array"}}},"description":"List assets to add to the board.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBoardAssetsResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/AddBoardAssetsResult"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"InsufficientAccess"},"404":{"description":"BoardNotFound"}},"summary":"Add assets to a board","tags":["Boards"]}},"/v3/boards/{board_id}/assets/{asset_id}":{"delete":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to remove an asset from a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n","operationId":"Boards_RemoveAsset","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"InsufficientAccess"},"404":{"description":"BoardNotFound"}},"summary":"Remove an asset from a board","tags":["Boards"]},"put":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place.\r\nMore information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to add an asset to a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.\r\nPlease see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n\r\n","operationId":"Boards_AddAsset","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"AssetNotFound"},"404":{"description":"BoardNotFound"}},"summary":"Add an asset to a board","tags":["Boards"]}},"/v3/boards/{board_id}/comments":{"get":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve all comments for a specific board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n","operationId":"Boards_GetComments","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentsList"}},"text/json":{"schema":{"$ref":"#/components/schemas/CommentsList"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"404":{"description":"BoardNotFound"}},"summary":"Get comments from a board","tags":["Boards"]},"post":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to add a comment to a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n","operationId":"Boards_AddComment","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CommentRequest"}}},"description":"Comment to be added to the board.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentCreated"}},"text/json":{"schema":{"$ref":"#/components/schemas/CommentCreated"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"InsufficientAccess"},"404":{"description":"BoardNotFound"}},"summary":"Add a comment to a board","tags":["Boards"]}},"/v3/boards/{board_id}/comments/{comment_id}":{"delete":{"deprecated":false,"description":"Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq).\r\nUse this endpoint to delete a comment from a board.\r\n\r\nYou'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n","operationId":"Boards_DeleteComment","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"in":"path","name":"board_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"comment_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"CommentDeleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"403":{"description":"InsufficientAccess"},"404":{"description":"BoardNotFound"}},"summary":"Delete a comment from a board","tags":["Boards"]}},"/v3/collections":{"get":{"deprecated":false,"description":"Use this endpoint to retrieve collections associated with your Getty Images account. To browse available collections see our [Image collections page]( http://www.gettyimages.com/creative-images/collections).\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n","operationId":"Collections_GetCollections","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Collections.CollectionsList"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Collections.CollectionsList"}}}},"401":{"description":"Unauthorized"}},"summary":"Gets collections applicable for the customer.","tags":["Collections"]}},"/v3/countries":{"get":{"deprecated":false,"description":"Returns a list of country objects that contains country name, two letter ISO abbreviation and three letter ISO abbreviation.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.\r\n","operationId":"Countries_GetCountries","parameters":[{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Countries.CountriesList"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Countries.CountriesList"}}}},"401":{"description":"Unauthorized"}},"summary":"Gets countries codes and names.","tags":["Countries"]}},"/v3/downloads":{"get":{"deprecated":false,"description":"Returns information about a customer's previously downloaded assets.\r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n \r\n\t\r\nThis endpoint requires being a Getty Images customer to limit your results to only assets that you have a license to use, \r\nyou need to also include an authorization token in the header of your request. \r\nPlease consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.\r\n","operationId":"Downloads_GetDownloads","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"company_downloads","required":false,"schema":{"type":"boolean"}},{"description":"If specified, select assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). \r\n Any hour, minute, second values in the request are not used at this time. Date/times in the response are UTC. Default is 30 days prior to date_to.","in":"query","name":"date_from","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, select assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). \r\n Any hour, minute, second values in the request are not used at this time. Date/times in the response are UTC. Default is current date.","in":"query","name":"date_to","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Identifies page to return. Default is 1.","in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Specifies page size. Default is 30, maximum page_size is 100.","in":"query","name":"page_size","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Specifies product type to be included in the previous download results. To get previous iStockPhoto credit downloads, credit_pack must be selected.","in":"query","name":"product_type","required":false,"schema":{"type":"string","enum":["easyaccess","editorialsubscription","imagepack","premiumaccess","royaltyfreesubscription"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Downloads.GetDownloadsResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Downloads.GetDownloadsResponse"}}}},"400":{"description":"Bad request"},"401":{"description":"AuthorizationTokenRequired"},"403":{"description":"Forbidden"}},"summary":"Returns information about a customer's downloaded assets.","tags":["Downloads"]}},"/v3/downloads/images/{id}":{"post":{"deprecated":false,"description":"Use this endpoint to generate download URLs and related data for images you are authorized to download.\r\n\r\nMost product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.\r\n\r\nThe download limit for a given download period is covered in your product agreement established with Getty Images.\r\n\r\nYou'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n## Auto Downloads\r\nThe `auto_download` request query parameter specifies whether to automatically download the image.\r\n\r\nIf the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*. Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4).\r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=true\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 303 See Other\r\nLocation: https://delivery.gettyimages.com/...\r\n```\r\n\r\nIf the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the image. \r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=false\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 200 OK\r\n{\r\n\t\"uri\": \"https://delivery.gettyimages.com/...\"\r\n}\r\n```","operationId":"Downloads_PostDownloads","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"<remarks>\r\n Id of image to download.\r\n </remarks>","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"<remarks>\r\n Specifies whether to auto-download the image. If true is specified, a 303 SeeOther status is returned with a\r\n Location header set to the location of the image.\r\n If false is specified, the download URI will be returned in the response message.\r\n </remarks>","in":"query","name":"auto_download","required":false,"schema":{"type":"boolean"}},{"description":"<remarks>\r\n File Type expressed with three character file extension.\r\n </remarks>","in":"query","name":"file_type","required":false,"schema":{"type":"string","enum":["eps","jpg"]}},{"description":"<remarks>\r\n Specifies the pixel height of the particular image to download.\r\n Available heights can be found in the images/{ids} response for the specific image.\r\n If left blank, it will return the largest available size.\r\n </remarks>","in":"query","name":"height","required":false,"schema":{"type":"string"}},{"description":"<remarks>\r\n Identifier of the instance for the selected product offering type.\r\n </remarks>","in":"query","name":"product_id","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"<remarks>\r\n Product type.\r\n </remarks>","in":"query","name":"product_type","required":false,"schema":{"type":"string","enum":["easyaccess","editorialsubscription","imagepack","premiumaccess","royaltyfreesubscription"]}},{"description":"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.","in":"query","name":"use_team_credits","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/GettyImages.Models.Downloads.PremiumAccessDownloadData"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/System.Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/System.Object"}}}},"303":{"description":"See Other"},"400":{"description":"MissingRequiredQueryParameters"},"401":{"description":"AuthorizationTokenRequired"},"404":{"description":"ImageNotFound"}},"summary":"Download an image","tags":["Downloads"]}},"/v3/downloads/videos/{id}":{"post":{"deprecated":false,"description":"Use this endpoint to generate download URLs and related data for videos you are authorized to download.\r\n\r\nMost product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.\r\n\r\nThe download limit for a given download period is covered in your product agreement established with Getty Images.\r\n\r\nYou'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n\r\n## Auto Downloads\r\nThe `auto_download` request query parameter specifies whether to automatically download the video.\r\n\r\nIf the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*. Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4).\r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=true\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 303 See Other\r\nLocation: https://delivery.gettyimages.com/...\r\n```\r\n\r\nIf the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the video. \r\n\r\nClient Request:\r\n\r\n```\r\nhttps://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=false\r\n```\r\n\r\nServer Response:\r\n\r\n```\r\nHTTP/1.1 200 OK\r\n{\r\n\t\"uri\": \"https://delivery.gettyimages.com/...\"\r\n}\r\n```","operationId":"Downloads_PostVideoDownloads","parameters":[{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"<remarks>\r\n Id of video to download.\r\n </remarks>","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"<remarks>\r\n Specifies whether to auto-download the video. If true is specified, a 303 SeeOther status is returned with a\r\n Location header set to the location of the video.\r\n If false is specified, the download URI will be returned in the response message.\r\n </remarks>","in":"query","name":"auto_download","required":false,"schema":{"type":"boolean"}},{"description":"<remarks>\r\n Identifier of the instance for the selected product offering type.\r\n </remarks>","in":"query","name":"product_id","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Specifies the size to be downloaded.","in":"query","name":"size","required":false,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"use_team_credits","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/GettyImages.Models.Downloads.PremiumAccessDownloadData"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/System.Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/System.Object"}}}},"303":{"description":"See Other"},"400":{"description":"MissingRequiredQueryParameters"},"401":{"description":"AuthorizationTokenRequired"},"404":{"description":"VideoNotFound"}},"summary":"Download a video","tags":["Downloads"]}},"/v3/events":{"get":{"deprecated":false,"description":"This endpoint returns the detailed event metadata for all specified events. Getty Images news, sports and entertainment photographers and\r\nvideographers cover editorially relevant events occurring around the world. All images or video clips produced in association with \r\nan event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content \r\nproduced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) \r\nwill be consistently assigned an EventID. The Event framework may also be used to group similar content, such as \r\n\"Hats from the Royal Wedding\" or \"Odd-ballOffbeat images of the week\". \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. \r\n","operationId":"Events_GetBatch","parameters":[{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":false,"schema":{"type":"string"}},{"description":"A comma separated list of fields to return in the response.","in":"query","name":"fields","required":false,"explode":true,"schema":{"type":"array","items":{"enum":["id","child_event_count","editorial_segments","hero_image","image_count","location","name","start_date","type"],"type":"string"}}},{"description":"A comma separated list of event ids.","in":"query","name":"ids","required":false,"explode":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Events.EventsResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Events.EventsResult"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"404":{"description":"EventNotFound"}},"summary":"Get metadata for multiple events","tags":["Events"]}},"/v3/events/{id}":{"get":{"deprecated":false,"description":"This endpoint returns the detailed event metadata for a specified event. Getty Images news, sports and entertainment \r\nphotographers and videographers cover editorially relevant events occurring around the world. \r\nAll images or video clips produced in association with an event, are assigned the same EventID. \r\nEventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images \r\nbrand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be \r\nconsistently assigned an EventID. The Event framework may also be used to group similar content, such as \r\n\"Hats from the Royal Wedding\" or \"Odd-ballOffbeat images of the week\". \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html)\r\npage for more information on how to sign up for an API key. \r\n","operationId":"Events_Get","parameters":[{"description":"Provide a header to specify the language of result values.","in":"header","name":"Accept-Language","required":false,"schema":{"type":"string"}},{"description":"Provide access token in the format of 'Bearer {token}'.","in":"header","name":"Authorization","required":false,"schema":{"type":"string"}},{"description":"An event id.","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"A comma separated list of fields to return in the response.","in":"query","name":"fields","required":false,"explode":true,"schema":{"type":"array","items":{"enum":["id","child_event_count","editorial_segments","hero_image","image_count","location","name","start_date","type"],"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Events.Event"}},"text/json":{"schema":{"$ref":"#/components/schemas/GettyImages.Models.Events.Event"}}}},"400":{"description":"InvalidParameterValue"},"401":{"description":"Unauthorized"},"404":{"description":"EventNotFound"}},"summary":"Get metadata for a single event","tags":["Events"]}},"/v3/images":{"get":{"deprecated":false,"description":"This endpoint returns the detailed image metadata for all specified images. Due to a wide variety of available image resolutions,\r\nthe images are grouped into a handful of size categories for simplicity. \r\n\r\nYou'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) \r\npage for more information on how to sign up for an API key. \r\n\r\n## Working with Fields Sets\r\n\r\nFields sets are used in the **fields** request parameter to receive a suite of metadata fi