DownloadFile

Your account ID.

This is visible on the settings page:

https://www.bytescale.com/dashboard/settings

Example: "A623uY2"

Type: String

Length: 7

Absolute path to a file. Begins with a /.

Example: "/uploads/image.jpg"

Type: String

Min Length: 1

Max Length: 512

Specifies whether to cache the raw file in the Bytescale CDN.

Default: true

Type: Boolean

Specifies the maximum amount of time, in seconds, the file will be cached on the user's device and in the Bytescale CDN's edge cache.

Default: Please refer to your account's default cache settings in the Bytescale Dashboard.

Type: Number

Specifies the maximum amount of time, in seconds, that 404 responses will be cached in the Bytescale CDN's edge cache.

Default: Please refer to your account's default cache settings in the Bytescale Dashboard.

Type: Number

Forces the browser to display a download prompt for the file, instead of displaying the file in the browser.

When set to true, the Bytescale CDN will add a content-disposition: attachment header to the HTTP response.

Example: true

Type: Boolean

Carries the encrypted payload for an Encrypted URL: these are URLs where the query string portion of the URL has been encrypted using an API key. The query string cannot be read or modified without the API key used to encrypt the URL. When the request is received, Bytescale decrypts the query string and authorizes access using the current permissions of the API key.

This lets you securely grant access to private files via URLs (without requiring Authorization or Cookie headers).

See: Encrypted URLs

Example: "1.BMCyGyFk.6Kfhg5wI8t9AOaY1.tP2Q5uCTvhtefYNPjP7_wxv2mcWI65vLv4"

Type: String

Expires the URL at the given Unix epoch timestamp.

The value can be provided in either milliseconds or seconds since January 1, 1970, 00:00:00 UTC.

Must less than 7 days in the future.

See: Expiring URLs

Example: "1748005508"

Type: Number

Attaches custom metadata to the URL without affecting CDN cacheability or generating unique transformations.

To include metadata, add query string parameters that begin with meta-.

Example: ?meta-user=123&meta-product=abc

When the URL is processed, all meta-* parameters are automatically stripped before transformation or caching occurs. This ensures that variations in metadata do not result in new transformations.

Example: "user-id-123"

Type: String

Allows you to optionally specify the file path of the requested file via the query string instead of the URL path. When provided, the path query string parameter takes precedence and overrides any file path included in the URL path.

This is especially useful with Encrypted URLs, which only encrypt the query string portion of the URL. By placing the file path in the query string using the path parameter, you ensure the location of the file is hidden and protected from tampering.

Must start with a "/".

Example: "/example/image.jpg"

Type: String

Carries the signature for a Signed URL: these are URLs that have been signed using an API key. This signature ensures the URL cannot be modified. When the request is received, Bytescale verifies the signature and authorizes access using the current permissions of the API key.

This lets you securely grant access to private files via URLs (without requiring Authorization or Cookie headers).

See: Signed URLs

Example: "1.W2Sxdk7S.tbORdGfI3afWZAy79r6ivu7O6FnHei_bNZSB9MANIbU"

Type: String

Downloads the latest version of your file (if you have overwritten it) when added to the URL with a unique value.

The value of the version parameter can be anything, e.g. an incremental number, a timestamp, etc.

You only need to provide and update this value if/when you overwrite your file.

Example: "1"

Type: String

Add one of these Authorization header values to your request:

•Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.

•Option 2: use HTTP basic authorization with apikey as your username and your API key as your password.

For advanced options, please see:

https://www.bytescale.com/docs/auth

Type: String