Generates one or more temporary URLs for downloading a specific file in the Media Manager.
The generateFileDownloadUrl()
function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter.
To download different assets of the file, use the assetKeys
parameter which generates a download URL for each asset.
If no asset key is specified, it defaults to src
, which generates one download URL in the original file's format and quality.
Use this function to grant external clients access to a private media file. Use the expirationInMinutes
parameter to set the URL expiration time, and the expirationRedirectUrl
parameter to add a redirect URL when the URL expires.
To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the generateFilesDownloadUrl()
function.
Since this is a permanent URL, it is less secure. Therefore, to download private files, use the generateFileDownloadUrl()
function for each private file that you want to generate a download URL for.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function generateFileDownloadUrl(
fileId: string,
options: GenerateFileDownloadUrlOptions,
): Promise<GenerateFileDownloadUrlResponse>;
File ID.
You can also pass the files' Wix media URLs. For example, ["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]
.
Learn more in the File and Folder IDs article.
Options to use when generating a file's download URL.
import { files } from "wix-media.v2";
/* Sample fileId value: 'd4dde1_dee18c9ada174a818ccf75c50e72c739~mv2.jpg' */
async function myGenerateFileDownloadUrlFunction(fileId) {
try {
const result = await files.generateFileDownloadUrl(fileId);
return result;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* {
* "downloadUrls": [
* {
* "assetKey": "src",
* "url": "https://download-files.wixmp.com/media/d4dde1_dee18c9ada174a818ccf75c50e72c739~mv2.jpg?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ1cm46YXBwOmU2NjYzMGU3MTRmMDQ5MGFhZWExZjE0OWIzYjY5ZTMyIiwic3ViIjoidXJuOmFwcDplNjY2MzBlNzE0ZjA0OTBhYWVhMWYxNDliM2I2OWUzMiIsImF1ZCI6WyJ1cm46c2VydmljZTpmaWxlLmRvd25sb2FkIl0sImlhdCI6MTY5MjAyMTMxNSwiZXhwIjoxNjkyMDU3MzI1LCJqdGkiOiJjZTA1MzUxYy1jNDA4LTRlYmMtYWI0OC04MWM0NWJlZDlkM2IiLCJvYmoiOltbeyJwYXRoIjoiL21lZGlhL2Q0ZGRlMV9kZWUxOGM5YWRhMTc0YTgxOGNjZjc1YzUwZTcyYzczOX5tdjIuanBnIn1dXSwiZGlzIjp7ImZpbGVuYW1lIjoibmVvbS1BZGtKLUxncFRyRS11bnNwbGFzaC5qcGciLCJ0eXBlIjoiYXR0YWNobWVudCJ9fQ.HfZiuG7UFavOpgh2T0lVn56oZ9NpLoV3z9Gmnqptt8Y"
* }
* ]
* }
*/
There is 1 error with this status code.
This method may also return standard errors. Learn more about standard Wix errors.