Upload Widget

Raw Files

Use the UrlBuilder to get raw file URLs (i.e. URLs to original files):

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/raw/example.jpg"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.jpg"
});

Transformation Presets

Use the UrlBuilder to transform files using transformation presets:

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/thumbnail/example.jpg"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.jpg",
  options: {
    transformation: "preset",
    transformationPreset: "thumbnail"
  }
});

Images

Use the UrlBuilder to transform images using the Image Processing API:

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/image/example.jpg?w=800&h=600"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.jpg",
  options: {
    transformation: "image",
    transformationParams: {
      "w": 800,
      "h": 600
    }
  }
});

Videos

Use the UrlBuilder to transform videos using the Video Processing API:

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/video/example.mov?f=mp4-h264&h=1080"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.mov",
  options: {
    transformation: "video",
    transformationParams: {
      "f": "mp4-h264",
      "h": 1080
    }
  }
});

Audio

Use the UrlBuilder to transform audio using the Audio Processing API:

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/audio/example.wav?f=aac&br=192"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.wav",
  options: {
    transformation: "audio",
    transformationParams: {
      "f": "aac",
      "br": 192
    }
  }
});

Archives

Use the UrlBuilder to extract the file document.docx from the uploaded ZIP file example.zip:

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/archive/example.zip?m=extract&artifact=/document.docx"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.zip",
  options: {
    transformation: "archive",
    transformationParams: {
      m: "extract"
    },
    artifact: "/document.docx"
  }
});

API keys

You must always pass an apiKey to the Upload Widget configuration object.

With API key auth, the requester has access to the resources available to the API key:

• Secret API keys: have access to all API endpoints (see the Bytescale JavaScript SDK).

• Public API keys: have access to file upload, file download, and file listing API endpoints. File overwrites, file deletes, and all other destructive operations cannot be performed using public API keys. File listing is also disabled by default (but can be changed by editing the API key's settings).

Each API key can have its read/write access limited to a subset of files/folders via the API key's settings.

You must always use public API keys (e.g. public_***) in your client-side code.

JWTs (Optional)

You can optionally use JWTs to authorize your file uploads, downloads, and other Bytescale API requests:

• To authorize client-side requests using JWTs: use the AuthManager to establish a JWT cookie session.

• To authorize server-side requests using JWTs: pass your JWT via the authorization-token HTTP request header in all Bytescale API and Bytescale CDN requests. You can set this header via the headers configuration field, which is a sibling to the apiKey configuration field. You cannot use the AuthManager in your server-side code, as it relies on setting the browser's cookies directly.

  Alternatively: use secret API keys (e.g. secret_***) in your server-side code.

You must continue to pass an apiKey to your configuration object when using JWTs.

JWTs are designed for use in client-side code. For server-side code, you should use secret API keys instead.

JWTs work by allowing you to grant permissions on a user-by-user basis that exceed the permissions of a public API key.

For example, your public API key may allow file uploads, whereas your JWT may allow file deletions for a specific set of paths.

JWTs can also be used for cookie-based auth when using the AuthManager, allowing the user to download private files directly via the URL (as auth is performed implicitly via a session cookie). This allows the browser to display private files in <img> and <video> elements.

The Bytescale Upload Widget internally uses the Bytescale JavaScript SDK to perform file uploads, meaning file uploads from the Bytescale Upload Widget will use whichever JWT you configure via the AuthManager.beginAuthSession method from the Bytescale JavaScript SDK.