CustomSizeDimensions
{
"type": "object",
"example": {
"width": 800,
"height": 600
},
"properties": {
"width": {
"type": "integer",
"minimum": 100,
"description": "Custom width to resize the image to"
},
"height": {
"type": "integer",
"minimum": 100,
"description": "Custom height to resize the image to"
}
},
"description": "A custom height or a custom width to resize the image to, but not both (experimental)"
}
Descriptors
{
"type": "object",
"example": {
"id": "cinematic_minimal_tense",
"name": "Cinematic Minimal Tense",
"tags": [
"Tense",
"Cinematic",
"Negative",
"Simple Meter",
"4/4",
"Natural Minor",
"Dorian",
"Minimal",
"Adagio",
"Single Region",
"Main",
"Entertainment",
"Politics",
"Keys",
"Mid Pads",
"Fast",
"Slow",
"Slow",
"Voice",
"Medium Bright",
"Non Noisy",
"Medium Thick",
"Angelic",
"Direct",
"Percussion",
"Perc FX",
"Misc",
"Acoustic Pianos",
"Grand",
"Nice",
"Roomy",
"Pop",
"Upright",
"Clean",
"Classic",
"Keyboards",
"Digital Keyboard",
"Strings",
"Synth Basses",
"Fast",
"Dark",
"Thick",
"Sub",
"Synth Mallets",
"Dull",
"Mid Synth Beds",
"Slow",
"None",
"Medium Noisy",
"Harsh",
"Fast",
"Airy",
"Long Textures",
"Ambience",
"Synth Texture",
"Ethereal",
"Set Kicks",
"Processed",
"Hubcap Mallet",
"Wide",
"Tickie",
"Airy",
"Chamber",
"Thin",
"Organ",
"Cello Ensemble",
"Sweet",
"Big",
"Di",
"Raw",
"Bright",
"Tight",
"Chorus",
"Buzzy",
"Huge",
"Warm",
"Jazz",
"Brass",
"String",
"Hollow",
"Woodwind",
"Breathy",
"Crystal",
"Rhodes",
"Synth Piano",
"Noisy",
"Woody",
"Metallic",
"Reverse Piano",
"Full",
"Foley",
"Piano",
"Clean",
"Delayed",
"Reverb",
"Low Passed",
"Large",
"Medium",
"Small"
],
"bands": [
{
"id": "cinematic_minimal_tense_band_1",
"name": "Cinematic Minimal Tense Band 1"
},
{
"id": "cinematic_minimal_tense_band_2",
"name": "Cinematic Minimal Tense Band 2"
}
],
"previews": [
{
"url": "https://public-cdn.ampermusic.com/bands/previews/cinematic_minimal_tense_band_1_v1.mp3",
"content_type": "audio/mp3"
},
{
"url": "https://public-cdn.ampermusic.com/bands/previews/cinematic_minimal_tense_band_2_v1.mp3",
"content_type": "audio/mp3"
}
],
"max_tempo": 76,
"min_tempo": 58,
"instruments": [
{
"id": "blue_synth_pad",
"name": "Warm Pad - Lush"
},
{
"id": "direct_round_1_synth_bass",
"name": "Direct Round 1 Synth Bass"
},
{
"id": "direct_crystal_breath_mid_pad",
"name": "Direct Crystal Breath Mid Pad"
}
],
"average_render_speed": 8.242664029014177
},
"properties": {
"id": {
"type": "string",
"description": "The ID of the descriptor"
},
"name": {
"type": "string",
"description": "The name of the descriptor"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags that describe the descriptor"
},
"bands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bands"
},
"description": "The bands that are available to use this descriptor"
},
"previews": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Preview"
},
"description": "Preview of the descriptor"
},
"max_tempo": {
"type": "number",
"description": "The maximum beats per minute that the descriptor is intended to be used with"
},
"min_tempo": {
"type": "number",
"description": "The minimum beats per minute that the descriptor is intended to be used with"
},
"instruments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Instruments"
},
"description": "The instruments that can play with this descriptor"
},
"average_render_speed": {
"type": "number",
"description": "The average ratio of the length of the music to the time it takes to render; for example, a render speed of 3.0 generates 30 seconds of music in about 10 seconds"
}
},
"description": "Information about a descriptor"
}
DescriptorsListResult
{
"type": "object",
"example": {
"data": [
{
"id": "cinematic_minimal_tenseX",
"name": "Cinematic Minimal Tense",
"tags": [
"Tense",
"Cinematic",
"Negative",
"Simple Meter",
"4/4",
"Natural Minor",
"Dorian",
"Minimal",
"Adagio",
"Single Region",
"Main",
"Entertainment",
"Politics",
"Keys",
"Mid Pads",
"Fast",
"Slow",
"Slow",
"Voice",
"Medium Bright",
"Non Noisy",
"Medium Thick",
"Angelic",
"Direct",
"Percussion",
"Perc FX",
"Misc",
"Acoustic Pianos",
"Grand",
"Nice",
"Roomy",
"Pop",
"Upright",
"Clean",
"Classic",
"Keyboards",
"Digital Keyboard",
"Strings",
"Synth Basses",
"Fast",
"Dark",
"Thick",
"Sub",
"Synth Mallets",
"Dull",
"Mid Synth Beds",
"Slow",
"None",
"Medium Noisy",
"Harsh",
"Fast",
"Airy",
"Long Textures",
"Ambience",
"Synth Texture",
"Ethereal",
"Set Kicks",
"Processed",
"Hubcap Mallet",
"Wide",
"Tickie",
"Airy",
"Chamber",
"Thin",
"Organ",
"Cello Ensemble",
"Sweet",
"Big",
"Di",
"Raw",
"Bright",
"Tight",
"Chorus",
"Buzzy",
"Huge",
"Warm",
"Jazz",
"Brass",
"String",
"Hollow",
"Woodwind",
"Breathy",
"Crystal",
"Rhodes",
"Synth Piano",
"Noisy",
"Woody",
"Metallic",
"Reverse Piano",
"Full",
"Foley",
"Piano",
"Clean",
"Delayed",
"Reverb",
"Low Passed",
"Large",
"Medium",
"Small"
],
"bands": [
{
"id": "cinematic_minimal_tense_band_1X",
"name": "Cinematic Minimal Tense Band 1"
},
{
"id": "cinematic_minimal_tense_band_2X",
"name": "Cinematic Minimal Tense Band 2"
}
],
"previews": [
{
"url": "https://public-cdn.ampermusic.com/bands/previews/cinematic_minimal_tense_band_1_v1.mp3",
"content_type": "audio/mp3"
},
{
"url": "https://public-cdn.ampermusic.com/bands/previews/cinematic_minimal_tense_band_2_v1.mp3",
"content_type": "audio/mp3"
}
],
"max_tempo": 76,
"min_tempo": 58,
"instruments": [
{
"id": "blue_synth_padX",
"name": "Warm Pad - Lush"
},
{
"id": "direct_round_1_synth_bassX",
"name": "Direct Round 1 Synth Bass"
},
{
"id": "direct_crystal_breath_mid_padX",
"name": "Direct Crystal Breath Mid Pad"
}
],
"average_render_speed": 8.242664029014177
}
],
"page": 1,
"per_page": 1
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Descriptors"
},
"description": "List of descriptors"
},
"page": {
"type": "integer",
"description": "Current page that is returned"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
}
},
"description": "List Descriptors results"
}
DownloadHistory
{
"type": "object",
"example": {
"id": "a24499ca3ccd912a6d8316d45f953ef092",
"user": {
"username": "jdoe"
},
"image": {
"id": "1234567X",
"format": {
"size": "medium"
}
},
"license": "standard",
"download_time": "2021-05-20T20:31:46.000Z",
"is_downloadable": true,
"subscription_id": "s12345678"
},
"required": [
"id",
"download_time",
"license"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the download"
},
"user": {
"$ref": "#/components/schemas/DownloadHistoryUserDetails"
},
"audio": {
"$ref": "#/components/schemas/DownloadHistoryMediaDetails"
},
"image": {
"$ref": "#/components/schemas/DownloadHistoryMediaDetails"
},
"video": {
"$ref": "#/components/schemas/DownloadHistoryMediaDetails"
},
"license": {
"type": "string",
"description": "The name of the license of this download"
},
"metadata": {
"type": "object",
"description": "The metadata that was passed in the original licensing request"
},
"revshare": {
"$ref": "#/components/schemas/DownloadHistoryRevshareDetails"
},
"download_time": {
"type": "string",
"format": "date-time",
"description": "Date the media was downloaded the first time"
},
"is_downloadable": {
"type": "boolean",
"description": "Specifies if the media is downloadable via its respective downloads endpoint"
},
"subscription_id": {
"type": "string",
"description": "ID of the subscription used to perform this download"
}
},
"description": "Information about a downloaded media item. Applicable for all media types, only one of 'audio', 'image' or 'video' will be in a single DownloadHistory object"
}
DownloadHistoryDataList
{
"example": {
"data": [
{
"id": "e1eba3833793e77188d22caae8bac9f2cd",
"user": {
"username": "editorial_test_account_002"
},
"image": {
"id": "9763363ao",
"format": {
"size": "original"
}
},
"license": "premier_editorial_all_digital",
"metadata": {
"job": "Important project",
"other": "Important media",
"client": "Company A",
"purchase_order": "123456"
},
"download_time": "2021-07-15T15:46:34.000Z",
"is_downloadable": false,
"subscription_id": "s12345678"
}
],
"page": 1,
"per_page": 1,
"total_count": 2890
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadHistory"
},
"description": "Download events"
},
"page": {
"type": "integer",
"description": "The current page of results"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "Error list; appears only if there was an error"
},
"message": {
"type": "string",
"description": "Server-generated message, if any"
},
"per_page": {
"type": "integer",
"description": "The number of results per page"
},
"total_count": {
"type": "integer",
"description": "The total number of results across all pages"
}
},
"description": "List of download events"
}
DownloadHistoryFormatDetails
{
"type": "object",
"example": {
"size": "medium",
"format": "jpg"
},
"properties": {
"size": {
"type": "string",
"description": "The size of the downloaded media"
},
"format": {
"type": "string",
"description": "The format of the downloaded media"
}
},
"description": "Information about the format of a download"
}
DownloadHistoryMediaDetails
{
"type": "object",
"example": {
"id": "1234567X",
"format": {
"size": "medium",
"format": "jpg"
}
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the download history media details"
},
"format": {
"$ref": "#/components/schemas/DownloadHistoryFormatDetails"
}
},
"description": "Information about the downloaded media"
}
DownloadHistoryRevshareDetails
{
"type": "object",
"example": {
"purchase_amount": "8.65",
"purchase_currency": "USD"
},
"required": [
"purchase_amount",
"purchase_currency"
],
"properties": {
"purchase_amount": {
"type": "string",
"description": "The amount charged for the license"
},
"purchase_currency": {
"type": "string",
"description": "The currency the amount was charged in"
}
},
"description": "Pricing information for revenue-sharing transactions"
}
DownloadHistoryUserDetails
{
"type": "object",
"example": {
"username": "jdoe"
},
"required": [
"username"
],
"properties": {
"username": {
"type": "string",
"description": "The name of the user who downloaded the item"
}
},
"description": "Information about a user"
}
EditorialAssets
{
"type": "object",
"example": {
"original": {
"width": 5985,
"height": 3693,
"display_name": "Original",
"is_licensable": true
},
"small_jpg": {
"width": 500,
"height": 309,
"display_name": "Small",
"is_licensable": true
},
"thumb_170": {
"url": "https://editorial01.qa.shuttercorp.net/thumb/10687730b/272a999e/Shutterstock_10687730b.jpg",
"width": 170,
"height": 105
},
"thumb_220": {
"url": "https://editorial01.qa.shuttercorp.net/thumb-220/10687730b/927a6ebe/Shutterstock_10687730b.jpg",
"width": 220,
"height": 136
},
"medium_jpg": {
"width": 1000,
"height": 617,
"display_name": "Med",
"is_licensable": true
},
"watermark_450": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-450/10687730b/ff2443ad/Shutterstock_10687730b.jpg",
"width": 450,
"height": 278
},
"watermark_1500": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-1500/10687730b/ee2d7ae1/Shutterstock_10687730b.jpg",
"width": 1500,
"height": 926
}
},
"properties": {
"original": {
"$ref": "#/components/schemas/ImageSizeDetails"
},
"small_jpg": {
"$ref": "#/components/schemas/ImageSizeDetails"
},
"thumb_170": {
"$ref": "#/components/schemas/Thumbnail"
},
"thumb_220": {
"$ref": "#/components/schemas/Thumbnail"
},
"medium_jpg": {
"$ref": "#/components/schemas/ImageSizeDetails"
},
"watermark_450": {
"$ref": "#/components/schemas/Thumbnail"
},
"watermark_1500": {
"$ref": "#/components/schemas/Thumbnail"
}
},
"description": "Asset information, including size and thumbnail URLs"
}
EditorialCategory
{
"type": "object",
"example": {
"name": "Awards"
},
"properties": {
"name": {
"type": "string"
}
},
"description": "Name of an editorial category"
}
EditorialCategoryResults
{
"type": "object",
"example": {
"data": [
{
"name": "Animal"
},
{
"name": "Awards"
},
{
"name": "Art"
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialCategory"
},
"description": "List of editorial categories"
}
},
"description": "List of editorial categories"
}
EditorialContent
{
"type": "object",
"example": {
"id": "10687730b",
"title": "Soccer Premier League, Manchester, United Kingdom - 11 May 2021",
"aspect": 1.621,
"assets": {
"original": {
"width": 5985,
"height": 3693,
"display_name": "Original",
"is_licensable": true
},
"small_jpg": {
"width": 500,
"height": 309,
"display_name": "Small",
"is_licensable": true
},
"thumb_170": {
"url": "https://editorial01.qa.shuttercorp.net/thumb/10687730b/272a999e/Shutterstock_10687730b.jpg",
"width": 170,
"height": 105
},
"thumb_220": {
"url": "https://editorial01.qa.shuttercorp.net/thumb-220/10687730b/927a6ebe/Shutterstock_10687730b.jpg",
"width": 220,
"height": 136
},
"medium_jpg": {
"width": 1000,
"height": 617,
"display_name": "Med",
"is_licensable": true
},
"watermark_450": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-450/10687730b/ff2443ad/Shutterstock_10687730b.jpg",
"width": 450,
"height": 278
},
"watermark_1500": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-1500/10687730b/ee2d7ae1/Shutterstock_10687730b.jpg",
"width": 1500,
"height": 926
}
},
"byline": "Jon Super/AP/Shutterstock",
"caption": "",
"keywords": [
"england",
"europe",
"leicester city fc",
"manchester",
"manchester united fc",
"men's soccer",
"men's sports",
"premier league",
"professional soccer",
"soccer",
"sports",
"united kingdom",
"western europe",
"wsoc"
],
"categories": [
{
"name": "Sport"
}
],
"date_taken": "2021-05-11T00:00:00.000Z",
"description": "Security and stewards stand outside the Old Trafford stadium in Manchester, England, ahead of the English Premier League soccer match between Manchester United and Leicester City. This is the first Manchester United home match since fans protested against American owner Joel Glazer, forcing the postponement of the team's Premier League game against Liverpool. The protests prompted Glazer to publish a letter in which he pledged to accelerate discussions with fans about supporters being able to have a greater say at the club"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"aspect": {
"type": "number"
},
"assets": {
"$ref": "#/components/schemas/EditorialAssets"
},
"byline": {
"type": "string"
},
"caption": {
"type": "string"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialCategory"
},
"description": "List of categories"
},
"date_taken": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"special_instructions": {
"type": "string"
}
},
"description": "Metadata about editorial content"
}
EditorialContentDataList
{
"example": {
"data": [
{
"id": "10687730bX",
"title": "Soccer Premier League, Manchester, United Kingdom - 11 May 2021",
"aspect": 1.621,
"assets": {
"original": {
"width": 5985,
"height": 3693,
"display_name": "Original",
"is_licensable": true
},
"small_jpg": {
"width": 500,
"height": 309,
"display_name": "Small",
"is_licensable": true
},
"thumb_170": {
"url": "https://editorial01.qa.shuttercorp.net/thumb/10687730b/272a999e/Shutterstock_10687730b.jpg",
"width": 170,
"height": 105
},
"thumb_220": {
"url": "https://editorial01.qa.shuttercorp.net/thumb-220/10687730b/927a6ebe/Shutterstock_10687730b.jpg",
"width": 220,
"height": 136
},
"medium_jpg": {
"width": 1000,
"height": 617,
"display_name": "Med",
"is_licensable": true
},
"watermark_450": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-450/10687730b/ff2443ad/Shutterstock_10687730b.jpg",
"width": 450,
"height": 278
},
"watermark_1500": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-1500/10687730b/ee2d7ae1/Shutterstock_10687730b.jpg",
"width": 1500,
"height": 926
}
},
"byline": "Jon Super/AP/Shutterstock",
"caption": "",
"keywords": [
"england",
"europe",
"leicester city fc",
"manchester",
"manchester united fc",
"men's soccer",
"men's sports",
"premier league",
"professional soccer",
"soccer",
"sports",
"united kingdom",
"western europe",
"wsoc"
],
"categories": [
{
"name": "Sport"
}
],
"date_taken": "2021-05-11T00:00:00.000Z",
"description": "Security and stewards stand outside the Old Trafford stadium in Manchester, England, ahead of the English Premier League soccer match between Manchester United and Leicester City. This is the first Manchester United home match since fans protested against American owner Joel Glazer, forcing the postponement of the team's Premier League game against Liverpool. The protests prompted Glazer to publish a letter in which he pledged to accelerate discussions with fans about supporters being able to have a greater say at the club"
}
],
"page": 1,
"per_page": 5,
"total_count": 16
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialContent"
},
"description": "Editorial items"
},
"page": {
"type": "integer",
"description": "Current page of the response"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "Error list; appears only if there was an error"
},
"message": {
"type": "string",
"description": "Optional error message"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_count": {
"type": "integer",
"description": "Total count of all results"
}
},
"description": "List of editorial items"
}
EditorialCoverItem
{
"type": "object",
"example": {
"id": "9763363q",
"url": "https://editorial01.qa.shuttercorp.net/thumb/9763363q/51e28f39/Shutterstock_9763363q.jpg",
"width": 170,
"height": 117
},
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
}
},
"description": "Cover image for editorial livefeed"
}
EditorialImageCategoryResults
{
"type": "object",
"example": {
"data": [
{
"name": "Animal"
},
{
"name": "Awards"
},
{
"name": "Art"
},
{
"name": "Film Stills"
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialCategory"
}
}
},
"description": "List of editorial categories"
}
EditorialImageContentDataList
{
"example": {
"data": [
{
"id": "10687730bX",
"title": "Soccer Premier League, Manchester, United Kingdom - 11 May 2021",
"aspect": 1.621,
"assets": {
"original": {
"width": 5985,
"height": 3693,
"display_name": "Original",
"is_licensable": true
},
"small_jpg": {
"width": 500,
"height": 309,
"display_name": "Small",
"is_licensable": true
},
"thumb_170": {
"url": "https://editorial01.qa.shuttercorp.net/thumb/10687730b/272a999e/Shutterstock_10687730b.jpg",
"width": 170,
"height": 105
},
"thumb_220": {
"url": "https://editorial01.qa.shuttercorp.net/thumb-220/10687730b/927a6ebe/Shutterstock_10687730b.jpg",
"width": 220,
"height": 136
},
"medium_jpg": {
"width": 1000,
"height": 617,
"display_name": "Med",
"is_licensable": true
},
"watermark_450": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-450/10687730b/ff2443ad/Shutterstock_10687730b.jpg",
"width": 450,
"height": 278
},
"watermark_1500": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-1500/10687730b/ee2d7ae1/Shutterstock_10687730b.jpg",
"width": 1500,
"height": 926
}
},
"byline": "Jon Super/AP/Shutterstock",
"caption": "",
"keywords": [
"england",
"europe",
"leicester city fc",
"manchester",
"manchester united fc",
"men's soccer",
"men's sports",
"premier league",
"professional soccer",
"soccer",
"sports",
"united kingdom",
"western europe",
"wsoc"
],
"categories": [
{
"name": "Sport"
}
],
"date_taken": "2021-05-11T00:00:00.000Z",
"description": "Security and stewards stand outside the Old Trafford stadium in Manchester, England, ahead of the English Premier League soccer match between Manchester United and Leicester City. This is the first Manchester United home match since fans protested against American owner Joel Glazer, forcing the postponement of the team's Premier League game against Liverpool. The protests prompted Glazer to publish a letter in which he pledged to accelerate discussions with fans about supporters being able to have a greater say at the club"
}
],
"page": 1,
"per_page": 1,
"total_count": 23
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialContent"
},
"description": "Editorial items"
},
"page": {
"type": "integer",
"description": "Current page of the response"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "Error list; appears only if there was an error"
},
"message": {
"type": "string",
"description": "Optional error message"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_count": {
"type": "integer",
"description": "Total count of all results"
}
},
"description": "List of editorial items"
}
EditorialImageLivefeed
{
"type": "object",
"example": {
"id": "2018%2F07%2F17%2FPrince%20Charles%20and%20Camilla%20Duchess%20of%20Cornwall%20visit%20to%20Cornwall%2C%20Day%202",
"name": "Prince Charles and Camilla Duchess of Cornwall visit to Cornwall, Day 2",
"cover_item": {
"id": "9763363qX",
"url": "https://editorial01.qa.shuttercorp.net/thumb/9763363q/51e28f39/Shutterstock_9763363q.jpg",
"width": 170,
"height": 117
},
"created_time": "2018-07-17T12:42:03.000Z",
"total_item_count": 38
},
"required": [
"id",
"name",
"total_item_count"
],
"properties": {
"id": {
"type": "string",
"description": "Livefeed ID"
},
"name": {
"type": "string",
"description": "Name of the livefeed"
},
"cover_item": {
"$ref": "#/components/schemas/EditorialCoverItem"
},
"created_time": {
"type": "string",
"format": "date-time",
"description": "When the livefeed was initially created"
},
"total_item_count": {
"type": "integer",
"description": "Total count of items in the livefeed"
}
},
"description": "Metadata about editorial livefeed"
}
EditorialImageLivefeedList
{
"type": "object",
"example": {
"data": [
{
"id": "2018%2F07%2F17%2FPrince%20Charles%20and%20Camilla%20Duchess%20of%20Cornwall%20visit%20to%20Cornwall%2C%20Day%202X",
"name": "Prince Charles and Camilla Duchess of Cornwall visit to Cornwall, Day 2",
"cover_item": {
"id": "9763363qX",
"url": "https://editorial01.qa.shuttercorp.net/thumb/9763363q/51e28f39/Shutterstock_9763363q.jpg",
"width": 170,
"height": 117
},
"created_time": "2018-07-17T12:42:03.000Z",
"total_item_count": 38
}
],
"page": 1,
"per_page": 1,
"total_count": 5300
},
"required": [
"data",
"total_count"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialLivefeed"
},
"description": "Editorial livefeeds"
},
"page": {
"type": "integer",
"description": "Current page of the response"
},
"message": {
"type": "string",
"description": "Optional error message"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_count": {
"type": "integer",
"description": "Total count of all results"
}
},
"description": "List of editorial livefeeds"
}
EditorialLivefeed
{
"type": "object",
"example": {
"id": "2018%2F07%2F17%2FPrince%20Charles%20and%20Camilla%20Duchess%20of%20Cornwall%20visit%20to%20Cornwall%2C%20Day%202X",
"name": "Prince Charles and Camilla Duchess of Cornwall visit to Cornwall, Day 2",
"cover_item": {
"id": "9763363qX",
"url": "https://editorial01.qa.shuttercorp.net/thumb/9763363q/51e28f39/Shutterstock_9763363q.jpg",
"width": 170,
"height": 117
},
"created_time": "2018-07-17T12:42:03.000Z",
"total_item_count": 38
},
"required": [
"id",
"name",
"total_item_count"
],
"properties": {
"id": {
"type": "string",
"description": "Livefeed ID"
},
"name": {
"type": "string",
"description": "Name of the livefeed"
},
"cover_item": {
"$ref": "#/components/schemas/EditorialCoverItem"
},
"created_time": {
"type": "string",
"format": "date-time",
"description": "When the livefeed was initially created"
},
"total_item_count": {
"type": "integer",
"description": "Total count of items in the livefeed"
}
},
"description": "Metadata about editorial livefeed"
}
EditorialLivefeedList
{
"type": "object",
"example": {
"data": [
{
"id": "2018%2F07%2F17%2FPrince%20Charles%20and%20Camilla%20Duchess%20of%20Cornwall%20visit%20to%20Cornwall%2C%20Day%202X",
"name": "Prince Charles and Camilla Duchess of Cornwall visit to Cornwall, Day 2",
"cover_item": {
"id": "9763363qX",
"url": "https://editorial01.qa.shuttercorp.net/thumb/9763363q/51e28f39/Shutterstock_9763363q.jpg",
"width": 170,
"height": 117
},
"created_time": "2018-07-17T12:42:03.000Z",
"total_item_count": 38
}
],
"page": 1,
"per_page": 1,
"total_count": 56
},
"required": [
"data",
"total_count"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialLivefeed"
},
"description": "Editorial livefeeds"
},
"page": {
"type": "integer",
"description": "Current page of the response"
},
"message": {
"type": "string",
"description": "Optional error message"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_count": {
"type": "integer",
"description": "Total count of all results"
}
},
"description": "List of editorial livefeeds"
}
EditorialSearchResults
{
"type": "object",
"example": {
"data": [
{
"id": "10687730bX",
"title": "Soccer Premier League, Manchester, United Kingdom - 11 May 2021",
"aspect": 1.621,
"assets": {
"original": {
"width": 5985,
"height": 3693,
"display_name": "Original",
"is_licensable": true
},
"small_jpg": {
"width": 500,
"height": 309,
"display_name": "Small",
"is_licensable": true
},
"thumb_170": {
"url": "https://editorial01.qa.shuttercorp.net/thumb/10687730b/272a999e/Shutterstock_10687730b.jpg",
"width": 170,
"height": 105
},
"thumb_220": {
"url": "https://editorial01.qa.shuttercorp.net/thumb-220/10687730b/927a6ebe/Shutterstock_10687730b.jpg",
"width": 220,
"height": 136
},
"medium_jpg": {
"width": 1000,
"height": 617,
"display_name": "Med",
"is_licensable": true
},
"watermark_450": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-450/10687730b/ff2443ad/Shutterstock_10687730b.jpg",
"width": 450,
"height": 278
},
"watermark_1500": {
"url": "https://editorial01.qa.shuttercorp.net/wm-preview-1500/10687730b/ee2d7ae1/Shutterstock_10687730b.jpg",
"width": 1500,
"height": 926
}
},
"byline": "Jon Super/AP/Shutterstock",
"caption": "",
"keywords": [
"england",
"europe",
"leicester city fc",
"manchester",
"manchester united fc",
"men's soccer",
"men's sports",
"premier league",
"professional soccer",
"soccer",
"sports",
"united kingdom",
"western europe",
"wsoc"
],
"categories": [
{
"name": "Sport"
}
],
"date_taken": "2021-05-11T00:00:00.000Z",
"description": "Security and stewards stand outside the Old Trafford stadium in Manchester, England, ahead of the English Premier League soccer match between Manchester United and Leicester City. This is the first Manchester United home match since fans protested against American owner Joel Glazer, forcing the postponement of the team's Premier League game against Liverpool. The protests prompted Glazer to publish a letter in which he pledged to accelerate discussions with fans about supporters being able to have a greater say at the club"
}
],
"next": "eyJ2IjoyLCJzIjoxLCJwIjpbMF19",
"prev": "",
"per_page": 1,
"search_id": "BaMzOAkpHIvfnuWVRFs1ag",
"total_count": 46845
},
"required": [
"data",
"total_count"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialContent"
},
"description": "Editorial items"
},
"next": {
"type": "string",
"description": "Cursor value that represents the next page of results"
},
"page": {
"type": "integer",
"description": "Current page of the response"
},
"prev": {
"type": "string",
"description": "Cursor value that represents the previous page of results"
},
"message": {
"type": "string",
"description": "Optional error message"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"search_id": {
"type": "string",
"description": "Unique identifier for the search request"
},
"total_count": {
"type": "integer",
"description": "Total count of all results"
}
},
"description": "Editorial search results"
}
EditorialUpdatedContent
{
"type": "object",
"example": {
"id": "9804979n",
"title": "Hong Kong kicks off international e-Sports competition, China - 24 Aug 2018",
"aspect": 1.481,
"assets": {
"original": {
"width": 4831,
"height": 3263,
"display_name": "Original",
"is_licensable": true
},
"small_jpg": {
"width": 500,
"height": 337,
"display_name": "Small",
"is_licensable": true
},
"thumb_170": {
"url": "https://editorial01.shutterstock.com/thumb/9804979n/c4377a53/Shutterstock_9804979n.jpg",
"width": 170,
"height": 115
},
"thumb_220": {
"url": "https://editorial01.shutterstock.com/thumb-220/9804979n/c57a68c7/Shutterstock_9804979n.jpg",
"width": 220,
"height": 149
},
"medium_jpg": {
"width": 1000,
"height": 675,
"display_name": "Med",
"is_licensable": true
},
"watermark_450": {
"url": "https://editorial01.shutterstock.com/wm-preview-450/9804979n/37d19dce/Shutterstock_9804979n.jpg",
"width": 450,
"height": 304
},
"watermark_1500": {
"url": "https://editorial01.shutterstock.com/wm-preview-1500/9933285a/ab82fea4/Shutterstock_9933285a.jpg",
"width": 1040,
"height": 1500
}
},
"byline": "ALEX HOFFORD/EPA-EFE/Shutterstock",
"rights": {
"countries": "CAN,+DEU,+GBR,+USA,-*"
},
"caption": "",
"updates": [
"addition"
],
"keywords": [],
"categories": [],
"date_taken": "2018-08-24T00:00:00.000Z",
"description": "Members of the TyLoo e-Sports team from China prepare to face off against the Kinguin e-Sports team from Poland at the ICBC (Asia) e-Sports and Music Festival Hong Kong 2018, Hong Kong, China, 24 August 2018. The festival runs from 24 to 26 August with professional gamers from around the world competing in international e-sports tournaments.",
"updated_time": "2019-07-16T00:04:44.000Z",
"supplier_code": "EPA",
"commercial_status": {
"status": "available"
}
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"aspect": {
"type": "number"
},
"assets": {
"$ref": "#/components/schemas/EditorialAssets"
},
"byline": {
"type": "string"
},
"rights": {
"type": "object",
"properties": {
"countries": {
"type": "string"
}
}
},
"caption": {
"type": "string"
},
"updates": {
"type": "array",
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialCategory"
},
"description": "List of categories"
},
"date_taken": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"created_time": {
"type": "string",
"format": "date-time"
},
"updated_time": {
"type": "string",
"format": "date-time"
},
"supplier_code": {
"type": "string"
},
"commercial_status": {
"properties": {
"reason": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"special_instructions": {
"type": "string"
}
},
"description": "Metadata about updated editorial content"
}
EditorialUpdatedResults
{
"type": "object",
"example": {
"data": [
{
"id": "9804979nX",
"title": "Hong Kong kicks off international e-Sports competition, China - 24 Aug 2018",
"aspect": 1.481,
"assets": {
"original": {
"width": 4831,
"height": 3263,
"display_name": "Original",
"is_licensable": true
},
"small_jpg": {
"width": 500,
"height": 337,
"display_name": "Small",
"is_licensable": true
},
"thumb_170": {
"url": "https://editorial01.shutterstock.com/thumb/9804979n/c4377a53/Shutterstock_9804979n.jpg",
"width": 170,
"height": 115
},
"thumb_220": {
"url": "https://editorial01.shutterstock.com/thumb-220/9804979n/c57a68c7/Shutterstock_9804979n.jpg",
"width": 220,
"height": 149
},
"medium_jpg": {
"width": 1000,
"height": 675,
"display_name": "Med",
"is_licensable": true
},
"watermark_450": {
"url": "https://editorial01.shutterstock.com/wm-preview-450/9804979n/37d19dce/Shutterstock_9804979n.jpg",
"width": 450,
"height": 304
},
"watermark_1500": {
"url": "https://editorial01.shutterstock.com/wm-preview-1500/9933285a/ab82fea4/Shutterstock_9933285a.jpg",
"width": 1040,
"height": 1500
}
},
"byline": "ALEX HOFFORD/EPA-EFE/Shutterstock",
"rights": {
"countries": "CAN,+DEU,+GBR,+USA,-*"
},
"caption": "",
"updates": [
"addition"
],
"keywords": [],
"categories": [],
"date_taken": "2018-08-24T00:00:00.000Z",
"description": "Members of the TyLoo e-Sports team from China prepare to face off against the Kinguin e-Sports team from Poland at the ICBC (Asia) e-Sports and Music Festival Hong Kong 2018, Hong Kong, China, 24 August 2018. The festival runs from 24 to 26 August with professional gamers from around the world competing in international e-sports tournaments.",
"updated_time": "2019-07-16T00:04:44.000Z",
"supplier_code": "EPA",
"commercial_status": {
"status": "available"
}
}
],
"next": "eyJ2IjoxLCJzIjoxfQ==",
"prev": "",
"per_page": 1
},
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialUpdatedContent"
},
"description": "Editorial updated items"
},
"next": {
"type": "string",
"description": "Cursor value that represents the next page of results"
},
"prev": {
"type": "string",
"description": "Cursor value that represents the previous page of results"
},
"message": {
"type": "string",
"description": "Optional error message"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
}
},
"description": "Editorial updated results"
}
EditorialVideoAssets
{
"type": "object",
"example": {
"original": {
"fps": 30,
"width": 1080,
"format": "avc1",
"height": 1080,
"file_size": 82233387,
"display_name": "HD",
"is_licensable": true
},
"thumb_jpg": {
"url": "https://qa.editorial-cdn.shuttercorp.net/thumb-1/10679854a/M5TcAf30Ncjcge2eMTI4NjY=/Shutterstock_10679854a.jpg"
},
"preview_mp4": {
"url": "https://qa.editorial-cdn.shuttercorp.net/wm-preview-mp4/10679854a/M0T7A13aNej2g82bMTI4NjY=/Shutterstock_10679854a.mp4"
},
"preview_webm": {
"url": "https://qa.editorial-cdn.shuttercorp.net/wm-preview-webm/10679854a/M4T6A63fN2j5g929MTI4NjY=/Shutterstock_10679854a.webm"
}
},
"properties": {
"original": {
"$ref": "#/components/schemas/VideoSizeDetails"
},
"thumb_jpg": {
"$ref": "#/components/schemas/VideoPreviewUrl"
},
"preview_mp4": {
"$ref": "#/components/schemas/VideoPreviewUrl"
},
"preview_webm": {
"$ref": "#/components/schemas/VideoPreviewUrl"
}
},
"description": "Asset information, including size and thumbnail URLs"
}
EditorialVideoCategoryResults
{
"type": "object",
"example": {
"data": [
{
"name": "Animal"
},
{
"name": "Awards"
},
{
"name": "Art"
},
{
"name": "Film Stills"
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialCategory"
}
}
},
"description": "List of editorial video categories"
}
EditorialVideoContent
{
"type": "object",
"example": {
"id": "10679854a",
"title": "Peeps the Goose Has a Blast on a Jet Ski, Prior Lake, Minnesota, USA - 13 Nov 2020",
"aspect": 1,
"assets": {
"original": {
"fps": 30,
"width": 1080,
"format": "avc1",
"height": 1080,
"file_size": 82233387,
"display_name": "HD",
"is_licensable": true
},
"thumb_jpg": {
"url": "https://qa.editorial-cdn.shuttercorp.net/thumb-1/10679854a/M5TcAf30Ncjcge2eMTI4NjY=/Shutterstock_10679854a.jpg"
},
"preview_mp4": {
"url": "https://qa.editorial-cdn.shuttercorp.net/wm-preview-mp4/10679854a/M0T7A13aNej2g82bMTI4NjY=/Shutterstock_10679854a.mp4"
},
"preview_webm": {
"url": "https://qa.editorial-cdn.shuttercorp.net/wm-preview-webm/10679854a/M4T6A63fN2j5g929MTI4NjY=/Shutterstock_10679854a.webm"
}
},
"byline": "ViralHog/Shutterstock",
"caption": "",
"keywords": [
"2020",
"adorable",
"birds",
"bizarre",
"canadian goose",
"cute",
"domesticated animals",
"entertainment",
"feel good",
"flew",
"flies",
"fly",
"flying",
"fun",
"goose",
"jet skis",
"nature",
"odd",
"pets",
"played",
"playing",
"plays",
"prior lake",
"sports",
"strange",
"sweet",
"usa",
"viralhog",
"virals",
"water sports",
"weird"
],
"categories": [],
"date_taken": "2020-11-13T00:00:00.000Z",
"description": "Info from Licensor: \"Peeps the Canadian Goose has been raised with our family since a gosling. Peeps has made appearances on our local news channels, TV shows, and local newspapers. He has been trained to fly next to four wheelers, jet ski's, and boats. He has brought joy to many people during the pandemic including those with cancer.\""
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"aspect": {
"type": "number"
},
"assets": {
"$ref": "#/components/schemas/EditorialVideoAssets"
},
"byline": {
"type": "string"
},
"caption": {
"type": "string"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialCategory"
},
"description": "List of categories"
},
"date_taken": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
}
},
"description": "Metadata about editorial content"
}
EditorialVideoSearchResults
{
"type": "object",
"example": {
"data": [
{
"id": "10679854aX",
"title": "Peeps the Goose Has a Blast on a Jet Ski, Prior Lake, Minnesota, USA - 13 Nov 2020",
"aspect": 1,
"assets": {
"original": {
"fps": 30,
"width": 1080,
"format": "avc1",
"height": 1080,
"file_size": 82233387,
"display_name": "HD",
"is_licensable": true
},
"thumb_jpg": {
"url": "https://qa.editorial-cdn.shuttercorp.net/thumb-1/10679854a/M5TcAf30Ncjcge2eMTI4NjY=/Shutterstock_10679854a.jpg"
},
"preview_mp4": {
"url": "https://qa.editorial-cdn.shuttercorp.net/wm-preview-mp4/10679854a/M0T7A13aNej2g82bMTI4NjY=/Shutterstock_10679854a.mp4"
},
"preview_webm": {
"url": "https://qa.editorial-cdn.shuttercorp.net/wm-preview-webm/10679854a/M4T6A63fN2j5g929MTI4NjY=/Shutterstock_10679854a.webm"
}
},
"byline": "ViralHog/Shutterstock",
"caption": "",
"keywords": [
"2020",
"adorable",
"birds",
"bizarre",
"canadian goose",
"cute",
"domesticated animals",
"entertainment",
"feel good",
"flew",
"flies",
"fly",
"flying",
"fun",
"goose",
"jet skis",
"nature",
"odd",
"pets",
"played",
"playing",
"plays",
"prior lake",
"sports",
"strange",
"sweet",
"usa",
"viralhog",
"virals",
"water sports",
"weird"
],
"categories": [],
"date_taken": "2020-11-13T00:00:00.000Z",
"description": "Info from Licensor: \"Peeps the Canadian Goose has been raised with our family since a gosling. Peeps has made appearances on our local news channels, TV shows, and local newspapers. He has been trained to fly next to four wheelers, jet ski's, and boats. He has brought joy to many people during the pandemic including those with cancer.\""
}
],
"next": "eyJ2IjoyLCJzIjoyMCwicCI6WzBdfQ==",
"prev": "",
"per_page": 1,
"search_id": "zhmz9zLmpQehdTPvg8cacQ",
"total_count": 331
},
"required": [
"data",
"total_count"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EditorialVideoContent"
},
"description": "Editorial items"
},
"next": {
"type": "string",
"description": "Cursor value that represents the next page of results"
},
"page": {
"type": "integer",
"description": "Current page of the response"
},
"prev": {
"type": "string",
"description": "Cursor value that represents the previous page of results"
},
"message": {
"type": "string",
"description": "Optional error message"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"search_id": {
"type": "string",
"description": "Unique identifier for the search request"
},
"total_count": {
"type": "integer",
"description": "Total count of all results"
}
},
"description": "Editorial search results"
}
Error
{
"type": "object",
"example": {
"code": "VALIDATION_INVALID_TYPE",
"data": "'10'",
"path": "$.query.page",
"message": "Invalid type: string should be integer"
},
"required": [
"message"
],
"properties": {
"code": {
"type": "string",
"description": "The error code of this error"
},
"data": {
"type": "string",
"description": "Debugging information about the error"
},
"path": {
"type": "string",
"description": "Internal code reference to the source of the error"
},
"items": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of items that produced the error"
},
"message": {
"type": "string",
"description": "Specific details about this error"
}
},
"description": "Error object"
}
FeaturedCollection
{
"type": "object",
"example": {
"id": "19853",
"name": "Exercise & Fitness",
"cover_item": {
"url": "https://ak.picdn.net/assets/cms/b467415246debdab45825d915a548f8f79b57882-Collection_1_Thumnail.jpg"
},
"created_time": "2021-07-07T13:10:24.000Z",
"updated_time": "2021-07-07T13:10:24.000Z",
"total_item_count": 82,
"items_updated_time": "2021-07-08T12:33:37.000Z"
},
"required": [
"id",
"name",
"total_item_count"
],
"properties": {
"id": {
"type": "string",
"description": "Collection ID"
},
"name": {
"type": "string",
"description": "Name of the collection"
},
"hero_item": {
"$ref": "#/components/schemas/FeaturedCollectionCoverItem",
"description": "Top-level item that is meant as a cover asset, as the first asset seen to represent the collection"
},
"share_url": {
"type": "string",
"description": "Unique share url for the collection"
},
"cover_item": {
"$ref": "#/components/schemas/FeaturedCollectionCoverItem"
},
"created_time": {
"type": "string",
"format": "date-time",
"description": "Date that the collection was created"
},
"updated_time": {
"type": "string",
"format": "date-time",
"description": "Date that the collection was last modified"
},
"total_item_count": {
"type": "integer",
"description": "Total number of items in the collection"
},
"items_updated_time": {
"type": "string",
"format": "date-time",
"description": "Date that an item in the collection was last added or removed"
}
},
"description": "Metadata about a featured collection"
}
FeaturedCollectionCoverItem
{
"type": "object",
"example": {
"url": "https://ak.picdn.net/assets/cms/b467415246debdab45825d915a548f8f79b57882-Collection_1_Thumnail.jpg"
},
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "URL of the collection cover item"
}
},
"description": "Featured collection cover item metadata"
}
FeaturedCollectionDataList
{
"example": {
"data": [
{
"id": "19853X",
"name": "Exercise & Fitness",
"cover_item": {
"url": "https://ak.picdn.net/assets/cms/b467415246debdab45825d915a548f8f79b57882-Collection_1_Thumnail.jpg"
},
"created_time": "2021-07-07T13:10:24.000Z",
"updated_time": "2021-07-07T13:10:24.000Z",
"total_item_count": 82,
"items_updated_time": "2021-07-08T12:33:37.000Z"
}
],
"page": 1,
"per_page": 5,
"total_count": 123455
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturedCollection"
},
"description": "Featured collections"
},
"page": {
"type": "integer",
"description": "Current page that is returned"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "Error list; appears only if there was an error"
},
"message": {
"type": "string",
"description": "Server-generated message, if any"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_count": {
"type": "integer",
"description": "Total count of all results across all pages"
}
},
"description": "List of featured collections"
}
GenreList
{
"type": "object",
"example": {
"data": [
"Rock",
"Pop > Singer-Songwriter",
"Pop > Synth Pop",
"Production / Film Scores"
]
},
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of genres"
}
},
"description": "List of audio genres"
}
ISOCountryCode
{
"oneOf": [
{
"enum": [
"ABW",
"AFG",
"AGO",
"AIA",
"ALA",
"ALB",
"AND",
"ARE",
"ARG",
"ARM",
"ASM",
"ATA",
"ATF",
"ATG",
"AUS",
"AUT",
"AZE",
"BDI",
"BEL",
"BEN",
"BES",
"BFA",
"BGD",
"BGR",
"BHR",
"BHS",
"BIH",
"BLM",
"BLR",
"BLZ",
"BMU",
"BOL",
"BRA",
"BRB",
"BRN",
"BTN",
"BVT",
"BWA",
"CAF",
"CAN",
"CCK",
"CHE",
"CHL",
"CHN",
"CIV",
"CMR",
"COD",
"COG",
"COK",
"COL",
"COM",
"CPV",
"CRI",
"CUB",
"CUW",
"CXR",
"CYM",
"CYP",
"CZE",
"DEU",
"DJI",
"DMA",
"DNK",
"DOM",
"DZA",
"ECU",
"EGY",
"ERI",
"ESH",
"ESP",
"EST",
"ETH",
"FIN",
"FJI",
"FLK",
"FRA",
"FRO",
"FSM",
"GAB",
"GBR",
"GEO",
"GGY",
"GHA",
"GIB",
"GIN",
"GLP",
"GMB",
"GNB",
"GNQ",
"GRC",
"GRD",
"GRL",
"GTM",
"GUF",
"GUM",
"GUY",
"HKG",
"HMD",
"HND",
"HRV",
"HTI",
"HUN",
"IDN",
"IMN",
"IND",
"IOT",
"IRL",
"IRN",
"IRQ",
"ISL",
"ISR",
"ITA",
"JAM",
"JEY",
"JOR",
"JPN",
"KAZ",
"KEN",
"KGZ",
"KHM",
"KIR",
"KNA",
"KOR",
"KWT",
"LAO",
"LBN",
"LBR",
"LBY",
"LCA",
"LIE",
"LKA",
"LSO",
"LTU",
"LUX",
"LVA",
"MAC",
"MAF",
"MAR",
"MCO",
"MDA",
"MDG",
"MDV",
"MEX",
"MHL",
"MKD",
"MLI",
"MLT",
"MMR",
"MNE",
"MNG",
"MNP",
"MOZ",
"MRT",
"MSR",
"MTQ",
"MUS",
"MWI",
"MYS",
"MYT",
"NAM",
"NCL",
"NER",
"NFK",
"NGA",
"NIC",
"NIU",
"NLD",
"NOR",
"NPL",
"NRU",
"NZL",
"OMN",
"PAK",
"PAN",
"PCN",
"PER",
"PHL",
"PLW",
"PNG",
"POL",
"PRI",
"PRK",
"PRT",
"PRY",
"PSE",
"PYF",
"QAT",
"REU",
"ROU",
"RUS",
"RWA",
"SAU",
"SDN",
"SEN",
"SGP",
"SGS",
"SHN",
"SJM",
"SLB",
"SLE",
"SLV",
"SMR",
"SOM",
"SPM",
"SRB",
"SSD",
"STP",
"SUR",
"SVK",
"SVN",
"SWE",
"SWZ",
"SXM",
"SYC",
"SYR",
"TCA",
"TCD",
"TGO",
"THA",
"TJK",
"TKL",
"TKM",
"TLS",
"TON",
"TTO",
"TUN",
"TUR",
"TUV",
"TWN",
"TZA",
"UGA",
"UKR",
"UMI",
"URY",
"USA",
"UZB",
"VAT",
"VCT",
"VEN",
"VGB",
"VIR",
"VNM",
"VUT",
"WLF",
"WSM",
"YEM",
"ZAF",
"ZMB",
"ZWE"
],
"type": "string",
"format": "country-code-3"
},
{
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"AN",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
],
"type": "string",
"format": "country-code-2"
}
],
"example": "USA",
"description": "A valid ISO 3166-1 Alpha-2 or ISO 3166-1 Alpha-3 code."
}
Image
{
"type": "object",
"example": {
"id": "1572478477X",
"aspect": 1.5,
"assets": {
"mosaic": {
"url": "https://image.shutterstock.com/image-photo/stock-photo-cropped-image-of-woman-gardening-250nw-1572478477.jpg",
"width": 250,
"height": 167
},
"preview": {
"url": "https://image.shutterstock.com/display_pic_with_logo/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 450,
"height": 300
},
"huge_thumb": {
"url": "https://image.shutterstock.com/image-photo/cropped-image-woman-gardening-260nw-1572478477.jpg",
"width": 390,
"height": 260
},
"large_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_large/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 150,
"height": 100
},
"small_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_small/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 100,
"height": 67
},
"preview_1000": {
"url": "https://ak.picdn.net/shutterstock/photos/1572478477/watermark_1000/1706028c641ea2f443057287c67d9b91/preview_1000-1572478477.jpg",
"width": 1000,
"height": 667
},
"preview_1500": {
"url": "https://image.shutterstock.com/z/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 1500,
"height": 1000
}
},
"image_type": "photo",
"media_type": "image",
"contributor": {
"id": "250738318X"
},
"description": "cropped image of woman gardening",
"has_model_release": true,
"original_filename": "123.jpg"
},
"required": [
"id",
"media_type",
"contributor"
],
"properties": {
"id": {
"type": "string",
"description": "Image ID"
},
"url": {
"type": "string",
"description": "Link to image information page; included only for certain accounts"
},
"aspect": {
"type": "number",
"description": "Aspect ratio of the image in decimal format, such as 0.6667"
},
"assets": {
"$ref": "#/components/schemas/ImageAssets",
"description": "Image asset information"
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Model"
},
"description": "List of models"
},
"insights": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "AI-powered insights about how the asset will perform for the objective and audience"
},
"is_adult": {
"type": "boolean",
"description": "Whether or not this image contains adult content"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Keywords associated with the content of this image"
},
"releases": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of all releases of this image"
},
"added_date": {
"type": "string",
"format": "date",
"description": "Date that the image was added by the contributor"
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Category"
},
"description": "Categories that this image is a part of"
},
"image_type": {
"type": "string",
"description": "Type of image"
},
"media_type": {
"type": "string",
"description": "Media type of this image, should always be \"image\""
},
"contributor": {
"$ref": "#/components/schemas/Contributor"
},
"description": {
"type": "string",
"description": "Detailed description of the image"
},
"is_editorial": {
"type": "boolean",
"description": "Whether or not this image is editorial content"
},
"affiliate_url": {
"type": "string",
"format": "uri",
"description": "Affiliate referral link; appears only for registered affiliate partners"
},
"model_releases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelRelease"
},
"description": "List of model releases"
},
"is_illustration": {
"type": "boolean",
"description": "Whether or not this image is an illustration"
},
"has_model_release": {
"type": "boolean",
"description": "Indicates whether there are model releases for the image"
},
"has_property_release": {
"type": "boolean",
"description": "Indicates whether there are property releases for the image"
}
},
"description": "Information about an image"
}
ImageAssets
{
"type": "object",
"example": {
"preview": {
"url": "https://image.shutterstock.com/display_pic_with_logo/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 450,
"height": 300
},
"huge_thumb": {
"url": "https://image.shutterstock.com/image-photo/cropped-image-woman-gardening-260nw-1572478477.jpg",
"width": 390,
"height": 260
},
"large_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_large/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 150,
"height": 100
},
"small_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_small/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 100,
"height": 67
},
"preview_1000": {
"url": "https://ak.picdn.net/shutterstock/photos/1572478477/watermark_1000/1706028c641ea2f443057287c67d9b91/preview_1000-1572478477.jpg",
"width": 1000,
"height": 667
},
"preview_1500": {
"url": "https://image.shutterstock.com/z/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 1500,
"height": 1000
}
},
"properties": {
"preview": {
"$ref": "#/components/schemas/Thumbnail"
},
"huge_jpg": {
"$ref": "#/components/schemas/ImageSizeDetails"
},
"small_jpg": {
"$ref": "#/components/schemas/ImageSizeDetails"
},
"huge_thumb": {
"$ref": "#/components/schemas/Thumbnail"
},
"medium_jpg": {
"$ref": "#/components/schemas/ImageSizeDetails"
},
"vector_eps": {
"$ref": "#/components/schemas/ImageSizeDetails"
},
"large_thumb": {
"$ref": "#/components/schemas/Thumbnail"
},
"small_thumb": {
"$ref": "#/components/schemas/Thumbnail"
},
"preview_1000": {
"$ref": "#/components/schemas/Thumbnail"
},
"preview_1500": {
"$ref": "#/components/schemas/Thumbnail"
},
"supersize_jpg": {
"$ref": "#/components/schemas/ImageSizeDetails"
}
},
"description": "Information about the assets that are part of an image"
}
ImageCreateRequest
{
"type": "object",
"example": {
"base64_image": "R0lGODlhgACAAPcAAEwiBLyaLOzNUNmWFNjOrNSuN7x6PPzqeOTMgfKSDMyuTPzwsdi2dHwuBPzbVu"
},
"required": [
"base64_image"
],
"properties": {
"base64_image": {
"type": "string",
"description": "A Base 64 encoded jpeg or png; images can be no larger than 10mb and can be no larger than 10,000 pixels in width or height"
}
},
"description": "Request to upload an image"
}
ImageCreateResponse
{
"type": "object",
"example": {
"id": "Udb14e1c3540bdbf82b4b3fe12d3a44f2"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"description": "Image upload information"
}
ImageDataList
{
"example": {
"data": [
{
"id": "1572478477X",
"aspect": 1.5,
"assets": {
"preview": {
"url": "https://image.shutterstock.com/display_pic_with_logo/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 450,
"height": 300
},
"huge_thumb": {
"url": "https://image.shutterstock.com/image-photo/cropped-image-woman-gardening-260nw-1572478477.jpg",
"width": 390,
"height": 260
},
"large_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_large/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 150,
"height": 100
},
"small_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_small/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 100,
"height": 67
},
"preview_1000": {
"url": "https://ak.picdn.net/shutterstock/photos/1572478477/watermark_1000/1706028c641ea2f443057287c67d9b91/preview_1000-1572478477.jpg",
"width": 1000,
"height": 667
},
"preview_1500": {
"url": "https://image.shutterstock.com/z/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 1500,
"height": 1000
}
},
"image_type": "photo",
"media_type": "image",
"contributor": {
"id": "250738318X"
},
"description": "cropped image of woman gardening",
"has_model_release": true
}
],
"page": 1,
"per_page": 5,
"total_count": 123455
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
},
"description": "Images"
},
"page": {
"type": "integer",
"description": "Current page that is returned"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "Error list; appears only if there was an error"
},
"message": {
"type": "string",
"description": "Server-generated message, if any"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_count": {
"type": "integer",
"description": "Total count of all results across all pages"
}
},
"description": "List of images"
}
ImageSearchResults
{
"type": "object",
"example": {
"data": [
{
"id": "1572478477X",
"aspect": 1.5,
"assets": {
"mosaic": {
"url": "https://image.shutterstock.com/image-photo/stock-photo-cropped-image-of-woman-gardening-250nw-1572478477.jpg",
"width": 250,
"height": 167
},
"preview": {
"url": "https://image.shutterstock.com/display_pic_with_logo/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 450,
"height": 300
},
"huge_thumb": {
"url": "https://image.shutterstock.com/image-photo/cropped-image-woman-gardening-260nw-1572478477.jpg",
"width": 390,
"height": 260
},
"large_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_large/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 150,
"height": 100
},
"small_thumb": {
"url": "https://thumb7.shutterstock.com/thumb_small/250738318/1572478477/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 100,
"height": 67
},
"preview_1000": {
"url": "https://ak.picdn.net/shutterstock/photos/1572478477/watermark_1000/1706028c641ea2f443057287c67d9b91/preview_1000-1572478477.jpg",
"width": 1000,
"height": 667
},
"preview_1500": {
"url": "https://image.shutterstock.com/z/stock-photo-cropped-image-of-woman-gardening-1572478477.jpg",
"width": 1500,
"height": 1000
}
},
"image_type": "photo",
"media_type": "image",
"contributor": {
"id": "250738318X"
},
"description": "cropped image of woman gardening",
"has_model_release": true
}
],
"page": 1,
"per_page": 5,
"search_id": "749090bb-2967-4a20-b22e-c800dc845e10",
"total_count": 45,
"spellcheck_info": {}
},
"required": [
"data",
"total_count",
"search_id"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
},
"description": "List of images"
},
"page": {
"type": "integer",
"description": "Current page that is returned"
},
"message": {
"type": "string",
"description": "Server-generated message, if any"
},
"insights": {
"$ref": "#/components/schemas/Insights"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"search_id": {
"type": "string",
"description": "Unique identifier for the search request"
},
"total_count": {
"type": "integer",
"description": "Total count of all results across all pages"
},
"spellcheck_info": {
"type": "object",
"description": "Returns information if search phrase has potentially been mistyped or another query would lead to better search results"
}
},
"description": "Image search results"
}
ImageSizeDetails
{
"type": "object",
"example": {
"dpi": 300,
"width": 1000,
"format": "jpg",
"height": 667,
"file_size": 860200,
"display_name": "Med",
"is_licensable": true
},
"properties": {
"dpi": {
"type": "integer"
},
"width": {
"type": "integer",
"description": "Width of this image size"
},
"format": {
"type": "string",
"description": "Format of this image size"
},
"height": {
"type": "integer",
"description": "Height of this image size"
},
"file_size": {
"type": "integer",
"description": "File size (in bytes) of this image size"
},
"display_name": {
"type": "string",
"description": "Display name of this image size"
},
"is_licensable": {
"type": "boolean",
"description": "Whether or not this image can be licensed in this image size"
}
},
"description": "Image size information"
}
Insights
{
"type": "object",
"example": {
"label_performance": [
{
"name": "Nature",
"percentile_performance": 98.82123565673828
},
{
"name": "Outdoors",
"percentile_performance": 98.63294982910156
}
]
},
"required": [
"label_performance"
],
"properties": {
"label_performance": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"percentile_performance": {
"type": "number"
}
}
},
"description": "How effective the AI thinks an asset in the category is for the specified audience and objective, expressed as a percentile compared to other images"
}
},
"description": "AI-powered insights about an asset, based on the specified audience and objective"
}
Instrument
{
"type": "object",
"example": {
"id": "bright_roomy_kit",
"name": "Bright Roomy Kit",
"tags": [
"Percussion",
"Aux Percs",
"Set Cymbals",
"Crash",
"Open",
"Ride",
"Set Hi-Hat",
"Set Kicks",
"Stick Snare",
"Quad Toms",
"Roto Toms"
],
"previews": [
{
"url": "https://public-cdn.ampermusic.com/instruments/previews/bright_roomy_kit_v1.mp3",
"content_type": "audio/mp3"
}
]
},
"properties": {
"id": {
"type": "string",
"description": "The id of the instrument"
},
"name": {
"type": "string",
"description": "Name of the instrument"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags"
},
"previews": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Preview"
},
"description": "Preview of the instrument"
}
},
"description": "Information about an musical instrument"
}
InstrumentList
{
"type": "object",
"example": {
"data": [
"Orchestra",
"Organ",
"Oud",
"Pads",
"Electric Guitar"
]
},
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of instruments"
}
},
"description": "List of instruments"
}
Instruments
{
"type": "object",
"example": {
"id": "bright_roomy_kitX",
"name": "Bright Roomy Kit"
},
"properties": {
"id": {
"type": "string",
"description": "The string id of the instrument"
},
"name": {
"type": "string",
"description": "The string name of the instrument"
}
},
"description": "Instruments"
}
InstrumentsListResult
{
"type": "object",
"example": {
"data": [
{
"id": "bright_roomy_kitX",
"name": "Bright Roomy Kit",
"tags": [
"Percussion",
"Aux Percs",
"Set Cymbals",
"Crash",
"Open",
"Ride",
"Set Hi-Hat",
"Set Kicks",
"Stick Snare",
"Quad Toms",
"Roto Toms"
],
"previews": [
{
"url": "https://public-cdn.ampermusic.com/instruments/previews/bright_roomy_kit_v1.mp3",
"content_type": "audio/mp3"
}
]
}
],
"page": 1,
"per_page": 5
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Instrument"
},
"description": "List of instrumnets"
},
"page": {
"type": "integer",
"description": "Current page that is returned"
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
}
},
"description": "Image search results"
}
KeywordDataList
{
"example": {
"data": [
"nature",
"wildlife",
"animal",
"cute",
"bamboo",
"panda",
"china",
"wild",
"endangered",
"black",
"bear"
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "string"
},
"description": "Keywords"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "Error list; appears only if there was an error"
},
"message": {
"type": "string",
"description": "Server-generated message, if any"
}
},
"description": "List of keywords"
}
Language
{
"enum": [
"ar",
"bg",
"bn",
"cs",
"da",
"de",
"el",
"en",
"es",
"fi",
"fr",
"gu",
"he",
"hi",
"hr",
"hu",
"id",
"it",
"ja",
"kn",
"ko",
"ml",
"mr",
"nb",
"nl",
"or",
"pl",
"pt",
"ro",
"ru",
"sk",
"sl",
"sv",
"ta",
"te",
"th",
"tr",
"uk",
"ur",
"vi",
"zh",
"zh-Hant"
],
"type": "string",
"title": "language",
"example": "cs",
"description": "Language code"
}
LicenseAudio
{
"type": "object",
"example": {
"license": "audio_platform",
"audio_id": "123456789",
"search_id": "987654321"
},
"required": [
"audio_id"
],
"properties": {
"license": {
"enum": [
"audio_platform",
"premier_music_basic",
"premier_music_extended",
"premier_music_pro",
"premier_music_comp",
"asset_all_music"
],
"type": "string",
"description": "Type of license"
},
"audio_id": {
"type": "string",
"description": "ID of the track being licensed"
},
"search_id": {
"type": "string",
"description": "ID of the search that led to this licensing event"
}
},
"description": "An audio track in a licensing request"
}
LicenseAudioRequest
{
"type": "object",
"example": {
"audio": [
{
"license": "audio_platform",
"audio_id": "591623",
"metadata": {
"customer_id": "12345"
}
}
]
},
"required": [
"audio"
],
"properties": {
"audio": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseAudio"
},
"maxItems": 50,
"description": "List of audio tracks to license"
}
},
"description": "Audio license request data"
}