--- title: "Download API" url: "https://earlyaccess.developers.bynder.com/apis/download-api-1/versions/db8ee3be-70cd-48de-aa00-e2e94ab0239a" --- # Download API OpenAPI specification document. ```json {"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":"","MEDIAHIGHRES":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":"","MEDIAHIGHRES":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Download API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/v4/media/{id}/download":{"get":{"description":"Retrieve the download location for an asset.\n__Warning:__ Requires the MEDIAHIGHRES security role.\n__Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.\n__Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.\n__Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.\n","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"query","name":"type","required":false,"schema":{"default":"original","enum":["original","additional"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"disclaimer":{"example":"

1. The photographs and video in the mediabank are to be used by anyone and everyone.

","type":"string"},"s3_file":{"example":"___TEMPORARY_DOWNLOAD_URL___","type":"string"}},"type":"object"}}},"description":"URL from which you can download the requested asset file."},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Invalid type","type":"string"},"statuscode":{"example":"400","type":"string"}},"type":"object"}}},"description":"Invalid type"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Original file not available","type":"string"},"statuscode":{"example":"404","type":"string"}},"type":"object"}}},"description":"Original file not available"}},"summary":"Retrieve asset download location","tags":["Media download"]}},"/api/v4/media/{id}/download/{itemId}":{"get":{"description":"Retrieve the download location for a specific asset item.\n__Warning:__ Requires the MEDIAHIGHRES security role.\n__Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.\n__Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.\n__Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.\n","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"path","name":"itemId","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"query","name":"hash","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"disclaimer":{"example":"

1. The photographs and video in the mediabank are to be used by anyone and everyone.

","type":"string"},"s3_file":{"example":"___TEMPORARY_DOWNLOAD_URL___","type":"string"}},"type":"object"}}},"description":"URL from which you can download the requested asset file."}},"summary":"Retrieve specific asset item download location","tags":["Media download"]}},"/api/v4/media/{id}/{version}/download":{"get":{"description":"Retrieve the download location for a specific asset version.\n__Warning:__ Requires the MEDIAHIGHRES security role.\n__Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.\n__Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.\n__Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.\n","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"example":"3","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"disclaimer":{"example":"

1. The photographs and video in the mediabank are to be used by anyone and everyone.

","type":"string"},"s3_file":{"example":"___TEMPORARY_DOWNLOAD_URL___","type":"string"}},"type":"object"}}},"description":"URL from which you can download the requested asset file."}},"summary":"Retrieve asset version download location","tags":["Media download"]}}},"security":[{"OAuth2":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]},{"permanentToken":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Media download"}]} ```