uploadMedia

The uploadMedia function uploads a binary asset (image, video, document, …) to your project’s storage. It is the JavaScript/TypeScript counterpart of the POST /resource/upload REST endpoint.

You pass a single File or Blob. The client handles the rest internally — including the chunked upload protocol used by the REST endpoint — and returns the final { name, url } of the uploaded asset.

Example (browser, using a <input type="file">):

const input = document.querySelector<HTMLInputElement>('input[type=file]');
const file = input?.files?.[0];

if (file) {
  const media = await client.uploadMedia({ file });
  console.log(media.url); // https://storage.contentisland.net/.../filename.png
}

Caution

uploadMedia requires a Write Token as the client’s accessToken. Calling it with a read token returns 403 Forbidden.

Note

The client automatically splits the file into 20 MB chunks under the hood and reassembles them on the server. You do not need to manage X-Chunk-Upload, chunkOptions or uploadId yourself: those parameters are part of the underlying REST endpoint contract, which you only need if you want lower-level control over the upload.

Interface

export interface ApiClient {
  uploadMedia: (params: UploadMediaParams) => Promise<Media>;
  // ... other methods
}

export interface UploadMediaParams {
  file: Blob | File;
  fileName?: string;
}

export interface Media {
  name: string;
  url: string;
}

Parameters

The function accepts a single UploadMediaParams object.

Name	Description
file	The binary contents of the asset. In a browser, this is typically a File from a file input; in Node.js it can be a Blob.
fileName	Optional. Name to register the file under. Defaults to 'upload'. When file is a File, you usually want to pass file.name here.

Output

The function returns a Promise<Media> resolving to the final asset metadata:

const media = await client.uploadMedia({ file, fileName: file.name });
/*
  {
    name: 'ab12cd34-cover-image.png',
    url:  'https://storage.contentisland.net/your-project/ab12cd34-cover-image.png',
  }
*/

You can then use media.url directly anywhere in your application, or save it into a content field via updateContentFieldValue.