Snapshots

Standalone class — not a property on Sandbox.

Constructor

import { Snapshots } from "@opencomputer/sdk";

const snapshots = new Snapshots();
// or with explicit config:
const snapshots = new Snapshots({ apiKey: "...", apiUrl: "..." });

string

API key (falls back to OPENCOMPUTER_API_KEY env var)

string

API URL (falls back to OPENCOMPUTER_API_URL env var)

`snapshots.create(opts)`

Create a pre-built snapshot from a declarative image. HTTP API →

string

required

Unique snapshot name

Image

required

Declarative image definition

(log: string) => void

Build log streaming callback

Returns: Promise<SnapshotInfo>

`snapshots.list()`

List all snapshots. HTTP API → Returns: Promise<SnapshotInfo[]>

`snapshots.get(name)`

Get a snapshot by name. HTTP API →

string

required

Snapshot name

Returns: Promise<SnapshotInfo>

`snapshots.delete(name)`

Delete a snapshot. Existing sandboxes created from it are not affected. HTTP API →

string

required

Snapshot name

Returns: Promise<void>

Types

SnapshotInfo

interface SnapshotInfo {
  id: string;
  name: string;
  status: string;       // "building" | "ready" | "failed"
  contentHash: string;
  checkpointId: string;
  manifest: object;
  createdAt: string;
  lastUsedAt: string;
}

Image Secret Stores

⌘I

Getting Started

Sandboxes

Reserved Capacity

Agent SDK

Hosted Agents

CLI

Guides

TypeScript SDK

Python SDK

CLI Reference

API Reference

Resources

Constructor

`snapshots.create(opts)`

`snapshots.list()`

`snapshots.get(name)`

`snapshots.delete(name)`

Types

​Constructor

​snapshots.create(opts)

​snapshots.list()

​snapshots.get(name)

​snapshots.delete(name)

​Types

Constructor

`snapshots.create(opts)`

`snapshots.list()`

`snapshots.get(name)`

`snapshots.delete(name)`

Types