boot

Boot a BrowserPod Pod with your API key to start an isolated, in-browser Linux runtime, optionally persisting its filesystem with a storageKey.

class BrowserPod {
  static async boot(opts: {
    apiKey: string;
    nodeVersion?: string;
    storageKey?: string;
    userImage?: string;
  }): Promise<BrowserPod>;
}

Parameters

opts (object) - Initialization options passed as an object.

Options

apiKey (string) - The API key to use.
nodeVersion (string, optional) - The version of Node.js to use. Currently only “22” is allowed.
storageKey (string, optional) - Identifies the pod’s persistent storage.
- Omitted → ephemeral: fresh disk each boot, nothing is saved between sessions.
- Provided → persistent: the same key resumes the same disk, a different key starts a separate one.
userImage (string, optional) - A URL pointing to a custom ext2 filesystem image that will be mounted directly on the /home directory of the pod’s filesystem.

Returns

boot returns a Promise which is resolved when the Pod is ready to be used. It returns the newly created Pod.

Notes

Calling this method deducts 10 tokens from your BrowserPod account balance. It will fail if not enough tokens are available.