TypeScript SDK

1
import { ChaserClient } from "chaser-sdk";
2
3
const client = new ChaserClient({
4
  apiKey: process.env.CHASER_API_KEY,
5
  account: "personal"  // or an organization name
6
});

1
// Create a browser session
2
const browser = await client.sessions.create({
3
  session_type: "browser",
4
  ephemeral: true
5
});
6
7
// Create a sandbox session with a workspace
8
const sandbox = await client.sessions.create({
9
  session_type: "sandbox",
10
  workspace: "my-project"
11
});
12
13
// Wait for the session to be ready
14
await client.sessions.waitUntilReady(sandbox.id);
15
16
// Runtime self-test
17
const diagnostics = await client.sessions.selfTest(sandbox.id);
18
console.log(diagnostics.runtime.tools.node);

1
const session = await client.sessions.create({
2
  session_type: "sandbox",
3
  ephemeral: true,
4
  proxy: "socks5h://user:pass@proxy.example.com:1080"
5
});

1
// Run in an existing session
2
const result = await client.exec.inSession(sandbox.id, {
3
  command: "npm ci && npm test",
4
  cwd: "/workspace"
5
});
6
7
// Run with auto-provisioned ephemeral sandbox
8
const result = await client.exec.run({
9
  ephemeral: true,
10
  image: "node:20-bookworm",
11
  command: "node -e \"console.log(42)\""
12
});
13
14
console.log(result.output);

1
// Create a workspace
2
const workspace = await client.workspaces.create({
3
  name: "frontend-app",
4
  session_type: "sandbox",
5
  image: "ghcr.io/example/dev:latest"
6
});
7
8
// Create a snapshot
9
await client.workspaces.snapshots.create("frontend-app", {
10
  name: "before-upgrade"
11
});
12
13
// Clone from a template
14
await client.workspaces.create({
15
  clone_from: "frontend-app",
16
  name: "frontend-app-feature"
17
});
18
19
// Delete by selector (name or UUID)
20
await client.workspaces.delete(workspace.name, { force: true });

1
await client.files.uploadText(session.id, "/workspace/hello.txt", "hello");
2
const text = await client.files.downloadText(session.id, "/workspace/hello.txt");

1
const url = client.sessions.forwardUrl(session.id, 3000);
2
// => https://<session_id>.chaser.sh/forward/3000/

1
const browser = await client.sessions.create({
2
  session_type: "browser",
3
  ephemeral: true
4
});
5
6
const version = await client.browser.version(browser.id);
7
const cdpUrl = await client.browser.cdpWebSocketUrl(browser.id);
8
const cdp = await client.browser.connect(browser.id);
9
console.log(version.Browser, cdpUrl);
10
await cdp.send("Browser.getVersion");
11
cdp.close();

1
const orgClient = client.withAccount("Acme Engineering");
2
3
const sa = await orgClient.accounts.serviceAccounts.create("ci-bot");
4
const key = await orgClient.accounts.serviceAccounts.keys.create(sa.id, {
5
  name: "ci-key",
6
  scopes: ["sessions.read", "workspaces.write", "exec.write"]
7
});

1
import { ChaserApiError } from "chaser-sdk";
2
3
try {
4
  await client.workspaces.delete("frontend-app");
5
} catch (error) {
6
  if (error instanceof ChaserApiError) {
7
    console.log(error.status, error.code, error.rateLimit?.remaining);
8
  }
9
  throw error;
10
}