generateFileDownloadUrl( )

Generates one or more temporary URLs for downloading a specific file in the Media Manager.

To download different assets of the file, specify the assetKeys parameter which generates a download URL for each asset. If no assetKey is specified, it defaults to src, which generates one download URL in the original file's format and quality.

Call this endpoint to grant external clients access to a private media file. Specify 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, call the Generate Files Download URL endpoint. Since this is a permanent URL, it is less secure. Therefore, to download private files, call the Generate File Download URL endpoint for each private file that you want to generate a download URL for.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings Services and Settings
Manage Media Manager
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
fileIdstringRequired

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.

optionsGenerateFileDownloadUrlOptions

Options to use when generating a file's download URL.

Returns
Return Type:Promise<GenerateFileDownloadUrlResponse>
JavaScript
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?