boot

Initialize a pod instance 

class BrowserPod {
  static async boot(opts: {
    apiKey: string;
    nodeVersion?: string;
    storageKey?: 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 to use. Currently only “22” is allowed.
  • storageKey (string, optional) - An arbitrary string used to support multiple pods on the same origin or multiple tabs in parallel. For example, boot({ apiKey: "...", storageKey: "vite" }) and boot({ apiKey: "...", storageKey: "app-12345" }) allocate two completely independent disks.

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.

Was this page helpful?
Suggest changes
run