Skip to main content
Hyperbrowser Sandboxes are isolated cloud environments purposefully built for agentic workflows. Get started with a quick example in less than 30 seconds.

Prerequisites

There are two main ways to get started with Hyperbrowser:
  1. For SDK use, install the SDK and grab your API key from the Hyperbrowser Dashboard.
  2. For CLI use, install hx and run hx configure --api-key <your_api_key> once.
npm install @hyperbrowser/sdk

Setup

import { Hyperbrowser } from "@hyperbrowser/sdk";

const client = new Hyperbrowser({
  apiKey: process.env.HYPERBROWSER_API_KEY,
});

Quick Example

const sandbox = await client.sandboxes.create({
  imageName: "node",
  timeoutMinutes: 30,
});

const result = await sandbox.exec("node -e 'console.log(\"hello world\")'");
console.log(result.stdout);

Start Here

Creating Sandboxes

Create a sandbox from a base image or snapshot and configure runtime options.

Base Images

Choose from the built-in node, python, and node-chromium images.

Custom Images

Build and upload your own Docker-based runtime image with the CLI.

Local Filesystem

Read, write, watch, upload, download, and presign file transfers.

Core Capabilities

Processes

Run one-shot commands or manage long-running background processes.

Terminal

Open interactive terminal sessions inside a running sandbox.

Snapshots

Capture memory snapshots and restore new sandboxes from them.