Overview

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

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

// 1) Create volume
const volume = await client.volumes.create({ name: "my-workspace" });

// 2) Create sandbox with mounted volume
const sandbox = await client.sandboxes.create({
  imageName: "node",
  mounts: {
    "/mnt/workspace": {
      id: volume.id,
      type: "rw",
    },
  },
});

// 3) Write/read through mounted path
await sandbox.files.writeText("/mnt/workspace/hello.txt", "hello from volume");
const text = await sandbox.files.readText("/mnt/workspace/hello.txt");
console.log(text);

from hyperbrowser import Hyperbrowser

client = Hyperbrowser(api_key="YOUR_API_KEY")

# 1) Create volume
volume = client.volumes.create({"name": "my-workspace"})

# 2) Create sandbox with mounted volume
sandbox = client.sandboxes.create(
    {
        "image_name": "node",
        "mounts": {
            "/mnt/workspace": {
                "id": volume.id,
                "type": "rw",
            }
        },
    }
)

# 3) Write/read through mounted path
sandbox.files.write_text("/mnt/workspace/hello.txt", "hello from volume")
text = sandbox.files.read_text("/mnt/workspace/hello.txt")
print(text)

from hyperbrowser import Hyperbrowser
from hyperbrowser.models import (
    CreateSandboxParams,
    CreateVolumeParams,
    SandboxVolumeMount,
)

client = Hyperbrowser(api_key="YOUR_API_KEY")

# 1) Create volume
volume = client.volumes.create(CreateVolumeParams(name="my-workspace"))

# 2) Create sandbox with mounted volume
sandbox = client.sandboxes.create(
    CreateSandboxParams(
        image_name="node",
        mounts={
            "/mnt/workspace": SandboxVolumeMount(
                id=volume.id,
                type="rw",
            )
        },
    )
)

# 3) Write/read through mounted path
sandbox.files.write_text("/mnt/workspace/hello.txt", "hello from volume")
text = sandbox.files.read_text("/mnt/workspace/hello.txt")
print(text)

# 1) Create volume
volume_id=$(hx --json vm volumes create my-workspace | jq -r '.id')

# 2) Create sandbox with mounted volume
sandbox_id=$(hx --json vm create node --mount "$volume_id:/mnt/workspace" | jq -r '.data.id')

# 3) Write/read through mounted path
hx file write "$sandbox_id" /mnt/workspace/hello.txt --data 'hello from volume'
hx file cat "$sandbox_id" /mnt/workspace/hello.txt

# 1) Create volume
volume_response=$(curl -sS -X POST https://api.hyperbrowser.ai/api/volume \
  -H "x-api-key: $HYPERBROWSER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"my-workspace"}')

volume_id=$(jq -r '.id' <<<"$volume_response")

# 2) Create sandbox with mounted volume
curl -X POST https://api.hyperbrowser.ai/api/sandbox \
  -H "x-api-key: $HYPERBROWSER_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"imageName\": \"node\",
    \"mounts\": {
      \"/mnt/workspace\": {
        \"id\": \"$volume_id\",
        \"type\": \"rw\"
      }
    }
  }"