langsmith 0.5.19 → 0.6.0

package/dist/experimental/sandbox/client.cjs

@@ -10,6 +10,27 @@ const async_caller_js_1 = require("../../utils/async_caller.cjs");
 const sandbox_js_1 = require("./sandbox.cjs");
 const errors_js_1 = require("./errors.cjs");
 const helpers_js_1 = require("./helpers.cjs");
+/**
+ * Sleep that can be interrupted by an AbortSignal.
+ * Resolves after `ms` milliseconds or rejects immediately if the signal fires.
+ */
+function sleepWithSignal(ms, signal) {
+    if (!signal) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+    signal.throwIfAborted();
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => {
+            signal.removeEventListener("abort", onAbort);
+            resolve();
+        }, ms);
+        function onAbort() {
+            clearTimeout(timer);
+            reject(signal.reason);
+        }
+        signal.addEventListener("abort", onAbort, { once: true });
+    });
+}
 /**
  * Get the default sandbox API endpoint from environment.
  *
@@ -29,7 +50,7 @@ function getDefaultApiKey() {
 /**
  * Client for interacting with the Sandbox Server API.
  *
- * This client provides a simple interface for managing sandboxes and templates.
+ * This client provides a simple interface for managing sandboxes and snapshots.
  *
  * @example
  * ```typescript
@@ -44,8 +65,13 @@ function getDefaultApiKey() {
  *   apiKey: "your-api-key",
  * });
  *
- * // Create a sandbox and run commands
- * const sandbox = await client.createSandbox("python-sandbox");
+ * // Build a snapshot, then create a sandbox from it
+ * const snapshot = await client.createSnapshot(
+ *   "python",
+ *   "python:3.12-slim",
+ *   1_073_741_824 // 1 GiB
+ * );
+ * const sandbox = await client.createSandbox(snapshot.id);
  * try {
  *   const result = await sandbox.run("python --version");
  *   console.log(result.stdout);
@@ -115,422 +141,60 @@ class SandboxClient {
     getApiKey() {
         return this._apiKey;
     }
-    // =========================================================================
-    // Volume Operations
-    // =========================================================================
-    /**
-     * Create a new persistent volume.
-     *
-     * Creates a persistent storage volume that can be referenced in templates.
-     *
-     * @param name - Volume name.
-     * @param options - Creation options including size and optional timeout.
-     * @returns Created Volume.
-     * @throws SandboxCreationError if volume provisioning fails.
-     * @throws ResourceTimeoutError if volume doesn't become ready within timeout.
-     */
-    async createVolume(name, options) {
-        const { size, timeout = 60 } = options;
-        const url = `${this._baseUrl}/volumes`;
-        const payload = {
-            name,
-            size,
-            wait_for_ready: true,
-            timeout,
-        };
-        const response = await this._fetch(url, {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-            signal: AbortSignal.timeout((timeout + 30) * 1000),
-        });
-        if (!response.ok) {
-            await (0, helpers_js_1.handleVolumeCreationError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Get a volume by name.
-     *
-     * @param name - Volume name.
-     * @returns Volume.
-     * @throws LangSmithResourceNotFoundError if volume not found.
-     */
-    async getVolume(name) {
-        const url = `${this._baseUrl}/volumes/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Volume '${name}' not found`, "volume");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * List all volumes.
-     *
-     * @returns List of Volumes.
-     */
-    async listVolumes() {
-        const url = `${this._baseUrl}/volumes`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithSandboxAPIError(`API endpoint not found: ${url}. Check that apiEndpoint is correct.`);
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        const data = await response.json();
-        return (data.volumes ?? []);
-    }
-    /**
-     * Delete a volume.
-     *
-     * @param name - Volume name.
-     * @throws LangSmithResourceNotFoundError if volume not found.
-     * @throws ResourceInUseError if volume is referenced by templates.
-     */
-    async deleteVolume(name) {
-        const url = `${this._baseUrl}/volumes/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url, { method: "DELETE" });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Volume '${name}' not found`, "volume");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleResourceInUseError)(response, "volume");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-    }
-    /**
-     * Update a volume's name and/or size.
-     *
-     * You can update the display name, size, or both in a single request.
-     * Only storage size increases are allowed (storage backend limitation).
-     *
-     * @param name - Current volume name.
-     * @param options - Update options.
-     * @returns Updated Volume.
-     * @throws LangSmithResourceNotFoundError if volume not found.
-     * @throws ValidationError if storage decrease attempted.
-     * @throws LangSmithResourceNameConflictError if newName is already in use.
-     */
-    async updateVolume(name, options) {
-        const { newName, size } = options;
-        if (newName === undefined && size === undefined) {
-            // Nothing to update, just return the current volume
-            return this.getVolume(name);
-        }
-        const url = `${this._baseUrl}/volumes/${encodeURIComponent(name)}`;
-        const payload = {};
-        if (newName !== undefined) {
-            payload.name = newName;
-        }
-        if (size !== undefined) {
-            payload.size = size;
-        }
-        const response = await this._fetch(url, {
-            method: "PATCH",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-        });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Volume '${name}' not found`, "volume");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleConflictError)(response, "volume");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    // =========================================================================
-    // Template Operations
-    // =========================================================================
-    /**
-     * Create a new SandboxTemplate.
-     *
-     * Only the container image, resource limits, and volume mounts can be
-     * configured. All other container details are handled by the server.
-     *
-     * @param name - Template name.
-     * @param options - Creation options including image and resource limits.
-     * @returns Created SandboxTemplate.
-     */
-    async createTemplate(name, options) {
-        const { image, cpu = "500m", memory = "512Mi", storage, volumeMounts, } = options;
-        const url = `${this._baseUrl}/templates`;
-        const payload = {
-            name,
-            image,
-            resources: {
-                cpu,
-                memory,
-            },
-        };
-        if (storage) {
-            payload.resources.storage = storage;
-        }
-        if (volumeMounts && volumeMounts.length > 0) {
-            payload.volume_mounts = volumeMounts.map((vm) => ({
-                volume_name: vm.volume_name,
-                mount_path: vm.mount_path,
-            }));
-        }
-        const response = await this._fetch(url, {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-        });
-        if (!response.ok) {
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Get a SandboxTemplate by name.
-     *
-     * @param name - Template name.
-     * @returns SandboxTemplate.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     */
-    async getTemplate(name) {
-        const url = `${this._baseUrl}/templates/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Template '${name}' not found`, "template");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * List all SandboxTemplates.
-     *
-     * @returns List of SandboxTemplates.
-     */
-    async listTemplates() {
-        const url = `${this._baseUrl}/templates`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithSandboxAPIError(`API endpoint not found: ${url}. Check that apiEndpoint is correct.`);
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        const data = await response.json();
-        return (data.templates ?? []);
-    }
-    /**
-     * Update a template.
-     *
-     * @param name - Current template name.
-     * @param options - Update options (e.g., newName).
-     * @returns Updated SandboxTemplate.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     * @throws LangSmithResourceNameConflictError if newName is already in use.
-     */
-    async updateTemplate(name, options) {
-        const { newName } = options;
-        if (newName === undefined) {
-            // Nothing to update, just return the current template
-            return this.getTemplate(name);
-        }
-        const url = `${this._baseUrl}/templates/${encodeURIComponent(name)}`;
-        const payload = { name: newName };
-        const response = await this._fetch(url, {
-            method: "PATCH",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-        });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Template '${name}' not found`, "template");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleConflictError)(response, "template");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Delete a SandboxTemplate.
-     *
-     * @param name - Template name.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     * @throws ResourceInUseError if template is referenced by sandboxes or pools.
-     */
-    async deleteTemplate(name) {
-        const url = `${this._baseUrl}/templates/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url, { method: "DELETE" });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Template '${name}' not found`, "template");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleResourceInUseError)(response, "template");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-    }
-    // =========================================================================
-    // Pool Operations
-    // =========================================================================
     /**
-     * Create a new Sandbox Pool.
-     *
-     * Pools pre-provision sandboxes from a template for faster startup.
-     *
-     * @param name - Pool name (lowercase letters, numbers, hyphens; max 63 chars).
-     * @param options - Creation options including templateName, replicas, and optional timeout.
-     * @returns Created Pool.
-     * @throws LangSmithResourceNotFoundError if template not found.
-     * @throws ValidationError if template has volumes attached.
-     * @throws ResourceAlreadyExistsError if pool with this name already exists.
-     * @throws ResourceTimeoutError if pool doesn't reach ready state within timeout.
-     * @throws QuotaExceededError if organization quota is exceeded.
+     * JSON POST helper. Sends JSON body, checks response status,
+     * and returns the Response for further processing.
+     * Throws on non-ok responses via handleClientHttpError.
+     * Callers can add specific status checks (e.g. 404) before calling this.
+     * @internal
      */
-    async createPool(name, options) {
-        const { templateName, replicas, timeout = 30 } = options;
-        const url = `${this._baseUrl}/pools`;
-        const payload = {
-            name,
-            template_name: templateName,
-            replicas,
-            wait_for_ready: true,
-            timeout,
-        };
+    async _postJson(url, body, options) {
         const response = await this._fetch(url, {
             method: "POST",
             headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
-            signal: AbortSignal.timeout((timeout + 30) * 1000),
-        });
-        if (!response.ok) {
-            await (0, helpers_js_1.handlePoolError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Get a Pool by name.
-     *
-     * @param name - Pool name.
-     * @returns Pool.
-     * @throws LangSmithResourceNotFoundError if pool not found.
-     */
-    async getPool(name) {
-        const url = `${this._baseUrl}/pools/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Pool '${name}' not found`, "pool");
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * List all Pools.
-     *
-     * @returns List of Pools.
-     */
-    async listPools() {
-        const url = `${this._baseUrl}/pools`;
-        const response = await this._fetch(url);
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithSandboxAPIError(`API endpoint not found: ${url}. Check that apiEndpoint is correct.`);
-            }
-            await (0, helpers_js_1.handleClientHttpError)(response);
-        }
-        const data = await response.json();
-        return (data.pools ?? []);
-    }
-    /**
-     * Update a Pool's name and/or replica count.
-     *
-     * You can update the display name, replica count, or both.
-     * The template reference cannot be changed after creation.
-     *
-     * @param name - Current pool name.
-     * @param options - Update options.
-     * @returns Updated Pool.
-     * @throws LangSmithResourceNotFoundError if pool not found.
-     * @throws ValidationError if template was deleted.
-     * @throws LangSmithResourceNameConflictError if newName is already in use.
-     * @throws QuotaExceededError if quota exceeded when scaling up.
-     */
-    async updatePool(name, options) {
-        const { newName, replicas } = options;
-        if (newName === undefined && replicas === undefined) {
-            // Nothing to update, just return the current pool
-            return this.getPool(name);
-        }
-        const url = `${this._baseUrl}/pools/${encodeURIComponent(name)}`;
-        const payload = {};
-        if (newName !== undefined) {
-            payload.name = newName;
-        }
-        if (replicas !== undefined) {
-            payload.replicas = replicas;
-        }
-        const response = await this._fetch(url, {
-            method: "PATCH",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify(payload),
+            body: JSON.stringify(body),
+            signal: options?.signal,
         });
         if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Pool '${name}' not found`, "pool");
-            }
-            if (response.status === 409) {
-                await (0, helpers_js_1.handleConflictError)(response, "pool");
-            }
-            await (0, helpers_js_1.handlePoolError)(response);
-        }
-        return (await response.json());
-    }
-    /**
-     * Delete a Pool.
-     *
-     * This will terminate all sandboxes in the pool.
-     *
-     * @param name - Pool name.
-     * @throws LangSmithResourceNotFoundError if pool not found.
-     */
-    async deletePool(name) {
-        const url = `${this._baseUrl}/pools/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url, { method: "DELETE" });
-        if (!response.ok) {
-            if (response.status === 404) {
-                throw new errors_js_1.LangSmithResourceNotFoundError(`Pool '${name}' not found`, "pool");
-            }
             await (0, helpers_js_1.handleClientHttpError)(response);
         }
+        return response;
     }
     // =========================================================================
     // Sandbox Operations
     // =========================================================================
     /**
-     * Create a new Sandbox.
+     * Create a new Sandbox from a snapshot.
      *
      * Remember to call `sandbox.delete()` when done to clean up resources.
      *
-     * @param templateName - Name of the SandboxTemplate to use.
-     * @param options - Creation options.
+     * Exactly one of `snapshotId` (positional) or `options.snapshotName` must
+     * be provided. When `snapshotName` is used, the server resolves it to a
+     * snapshot owned by the caller's tenant.
+     *
+     * @param snapshotId - ID of the snapshot to boot from. Create one with
+     *   `createSnapshot()` or `captureSnapshot()`, or pass an existing snapshot ID.
+     *   Pass `undefined` when booting by name via `options.snapshotName`.
+     * @param options - Creation options. Use `options.snapshotName` to boot
+     *   by snapshot name instead of ID.
      * @returns Created Sandbox.
      * @throws ResourceTimeoutError if timeout waiting for sandbox to be ready.
      * @throws SandboxCreationError if sandbox creation fails.
-     * @throws LangSmithValidationError if TTL values are invalid.
+     * @throws LangSmithValidationError if TTL values are invalid, or if neither
+     *   (or both) of `snapshotId` / `options.snapshotName` are provided.
      *
      * @example
      * ```typescript
-     * const sandbox = await client.createSandbox("python-sandbox");
+     * const snapshot = await client.createSnapshot(
+     *   "python",
+     *   "python:3.12-slim",
+     *   1_073_741_824
+     * );
+     * const sandbox = await client.createSandbox(snapshot.id);
+     * // Or, resolve by snapshot name:
+     * const sandbox = await client.createSandbox(undefined, {
+     *   snapshotName: "python",
+     * });
      * try {
      *   const result = await sandbox.run("echo hello");
      *   console.log(result.stdout);
@@ -539,15 +203,23 @@ class SandboxClient {
      * }
      * ```
      */
-    async createSandbox(templateName, options = {}) {
-        const { name, timeout = 30, waitForReady = true, ttlSeconds, idleTtlSeconds, } = options;
+    async createSandbox(snapshotId, options = {}) {
+        const { snapshotName, name, timeout = 30, waitForReady = true, ttlSeconds, idleTtlSeconds, vCpus, memBytes, fsCapacityBytes, proxyConfig, } = options;
+        if (!!snapshotId === !!snapshotName) {
+            throw new errors_js_1.LangSmithValidationError("Exactly one of snapshotId or options.snapshotName must be set", "snapshotId");
+        }
         (0, helpers_js_1.validateTtl)(ttlSeconds, "ttlSeconds");
         (0, helpers_js_1.validateTtl)(idleTtlSeconds, "idleTtlSeconds");
         const url = `${this._baseUrl}/boxes`;
         const payload = {
-            template_name: templateName,
             wait_for_ready: waitForReady,
         };
+        if (snapshotId) {
+            payload.snapshot_id = snapshotId;
+        }
+        if (snapshotName) {
+            payload.snapshot_name = snapshotName;
+        }
         if (waitForReady) {
             payload.timeout = timeout;
         }
@@ -560,6 +232,18 @@ class SandboxClient {
         if (idleTtlSeconds !== undefined) {
             payload.idle_ttl_seconds = idleTtlSeconds;
         }
+        if (vCpus !== undefined) {
+            payload.vcpus = vCpus;
+        }
+        if (memBytes !== undefined) {
+            payload.mem_bytes = memBytes;
+        }
+        if (fsCapacityBytes !== undefined) {
+            payload.fs_capacity_bytes = fsCapacityBytes;
+        }
+        if (proxyConfig !== undefined) {
+            payload.proxy_config = proxyConfig;
+        }
         const httpTimeout = waitForReady ? (timeout + 30) * 1000 : 30 * 1000;
         const response = await this._fetch(url, {
             method: "POST",
@@ -582,9 +266,9 @@ class SandboxClient {
      * @returns Sandbox.
      * @throws LangSmithResourceNotFoundError if sandbox not found.
      */
-    async getSandbox(name) {
+    async getSandbox(name, options) {
         const url = `${this._baseUrl}/boxes/${encodeURIComponent(name)}`;
-        const response = await this._fetch(url);
+        const response = await this._fetch(url, { signal: options?.signal });
         if (!response.ok) {
             if (response.status === 404) {
                 throw new errors_js_1.LangSmithResourceNotFoundError(`Sandbox '${name}' not found`, "sandbox");
@@ -679,9 +363,9 @@ class SandboxClient {
      * @returns ResourceStatus with status and optional status_message.
      * @throws LangSmithResourceNotFoundError if sandbox not found.
      */
-    async getSandboxStatus(name) {
+    async getSandboxStatus(name, options) {
         const url = `${this._baseUrl}/boxes/${encodeURIComponent(name)}/status`;
-        const response = await this._fetch(url);
+        const response = await this._fetch(url, { signal: options?.signal });
         if (!response.ok) {
             if (response.status === 404) {
                 throw new errors_js_1.LangSmithResourceNotFoundError(`Sandbox '${name}' not found`, "sandbox");
@@ -705,28 +389,243 @@ class SandboxClient {
      *
      * @example
      * ```typescript
-     * const sandbox = await client.createSandbox("python-sandbox", { waitForReady: false });
+     * const sandbox = await client.createSandbox(snapshot.id, { waitForReady: false });
      * // ... do other work ...
      * const readySandbox = await client.waitForSandbox(sandbox.name);
      * ```
      */
     async waitForSandbox(name, options = {}) {
-        const { timeout = 120, pollInterval = 1.0 } = options;
+        const { timeout = 120, pollInterval = 1.0, signal } = options;
         const deadline = Date.now() + timeout * 1000;
         let lastStatus = "provisioning";
         while (Date.now() < deadline) {
-            const statusResult = await this.getSandboxStatus(name);
+            signal?.throwIfAborted();
+            const statusResult = await this.getSandboxStatus(name, { signal });
             lastStatus = statusResult.status;
             if (statusResult.status === "ready") {
-                return this.getSandbox(name);
+                return this.getSandbox(name, { signal });
             }
             if (statusResult.status === "failed") {
                 throw new errors_js_1.LangSmithResourceCreationError(statusResult.status_message ?? `Sandbox '${name}' creation failed`, "sandbox");
             }
-            // Wait before polling again
-            await new Promise((resolve) => setTimeout(resolve, pollInterval * 1000));
+            // Wait before polling again, capped to remaining time + jitter
+            const remaining = deadline - Date.now();
+            const jitter = pollInterval * 200 * (Math.random() - 0.5); // ±10%
+            const delay = Math.min(pollInterval * 1000 + jitter, remaining);
+            if (delay > 0) {
+                await sleepWithSignal(delay, signal);
+            }
         }
         throw new errors_js_1.LangSmithResourceTimeoutError(`Sandbox '${name}' did not become ready within ${timeout}s`, "sandbox", lastStatus);
     }
+    /**
+     * Start a stopped sandbox and wait until ready.
+     *
+     * @param name - Sandbox name.
+     * @param options - Options with timeout.
+     * @returns Sandbox in "ready" status.
+     */
+    async startSandbox(name, options = {}) {
+        const { timeout = 120, signal } = options;
+        const url = `${this._baseUrl}/boxes/${encodeURIComponent(name)}/start`;
+        await this._postJson(url, {}, { signal });
+        return this.waitForSandbox(name, { timeout, signal });
+    }
+    /**
+     * Stop a running sandbox (preserves sandbox files for later restart).
+     *
+     * @param name - Sandbox name.
+     */
+    async stopSandbox(name) {
+        const url = `${this._baseUrl}/boxes/${encodeURIComponent(name)}/stop`;
+        await this._postJson(url, {});
+    }
+    // =========================================================================
+    // Snapshot Operations
+    // =========================================================================
+    /**
+     * Build a snapshot from a Docker image.
+     *
+     * Blocks until the snapshot is ready (polls with 2s interval).
+     *
+     * @param name - Snapshot name.
+     * @param dockerImage - Docker image to build from (e.g., "python:3.12-slim").
+     * @param fsCapacityBytes - Filesystem capacity in bytes.
+     * @param options - Additional options (registry credentials, timeout).
+     * @returns Snapshot in "ready" status.
+     */
+    async createSnapshot(name, dockerImage, fsCapacityBytes, options = {}) {
+        const { registryId, registryUrl, registryUsername, registryPassword, timeout = 60, signal, } = options;
+        const url = `${this._baseUrl}/snapshots`;
+        const payload = {
+            name,
+            docker_image: dockerImage,
+            fs_capacity_bytes: fsCapacityBytes,
+        };
+        if (registryId !== undefined) {
+            payload.registry_id = registryId;
+        }
+        if (registryUrl !== undefined) {
+            payload.registry_url = registryUrl;
+        }
+        if (registryUsername !== undefined) {
+            payload.registry_username = registryUsername;
+        }
+        if (registryPassword !== undefined) {
+            payload.registry_password = registryPassword;
+        }
+        const response = await this._postJson(url, payload, { signal });
+        const snapshot = (await response.json());
+        return this.waitForSnapshot(snapshot.id, { timeout, signal });
+    }
+    /**
+     * Capture a snapshot from a running sandbox.
+     *
+     * Blocks until the snapshot is ready (polls with 2s interval).
+     *
+     * @param sandboxName - Name of the sandbox to capture from.
+     * @param name - Snapshot name.
+     * @param options - Capture options (timeout).
+     * @returns Snapshot in "ready" status.
+     */
+    async captureSnapshot(sandboxName, name, options = {}) {
+        const { timeout = 60, signal } = options;
+        const url = `${this._baseUrl}/boxes/${encodeURIComponent(sandboxName)}/snapshot`;
+        const payload = { name };
+        const response = await this._postJson(url, payload, { signal });
+        const snapshot = (await response.json());
+        return this.waitForSnapshot(snapshot.id, { timeout, signal });
+    }
+    /**
+     * Get a snapshot by ID.
+     *
+     * @param snapshotId - Snapshot UUID.
+     * @returns Snapshot.
+     */
+    async getSnapshot(snapshotId, options) {
+        const url = `${this._baseUrl}/snapshots/${encodeURIComponent(snapshotId)}`;
+        const response = await this._fetch(url, { signal: options?.signal });
+        if (!response.ok) {
+            if (response.status === 404) {
+                throw new errors_js_1.LangSmithResourceNotFoundError(`Snapshot '${snapshotId}' not found`, "snapshot");
+            }
+            await (0, helpers_js_1.handleClientHttpError)(response);
+        }
+        return (await response.json());
+    }
+    /**
+     * List snapshots, optionally filtered and paginated server-side.
+     *
+     * The backend always paginates this endpoint. When `limit` is omitted the
+     * server applies a default page size (currently 50), so a single call is
+     * not guaranteed to return every snapshot visible to the tenant. To iterate
+     * through all results, repeat the call with increasing `offset` values (or
+     * an explicit `limit`) until fewer than `limit` snapshots come back.
+     *
+     * @param options - Optional filter/pagination options.
+     *   - `nameContains`: case-insensitive substring match on snapshot name.
+     *   - `limit`: page size; must be between 1 and 500 (inclusive). Defaults
+     *     to 50 server-side when omitted.
+     *   - `offset`: number of snapshots to skip; must be `>= 0`.
+     *
+     *   Values outside those ranges are rejected by the server.
+     * @returns A single page of Snapshots matching the provided filters.
+     *
+     * @example
+     * ```typescript
+     * const firstPage = await client.listSnapshots();
+     * const page = await client.listSnapshots({
+     *   nameContains: "python",
+     *   limit: 100,
+     *   offset: 0,
+     * });
+     * ```
+     */
+    async listSnapshots(options = {}) {
+        const { nameContains, limit, offset, signal } = options;
+        const params = new URLSearchParams();
+        if (nameContains !== undefined) {
+            params.set("name_contains", nameContains);
+        }
+        if (limit !== undefined) {
+            params.set("limit", String(limit));
+        }
+        if (offset !== undefined) {
+            params.set("offset", String(offset));
+        }
+        const query = params.toString();
+        const url = query
+            ? `${this._baseUrl}/snapshots?${query}`
+            : `${this._baseUrl}/snapshots`;
+        const response = await this._fetch(url, { signal });
+        if (!response.ok) {
+            await (0, helpers_js_1.handleClientHttpError)(response);
+        }
+        const data = await response.json();
+        return (data.snapshots ?? []);
+    }
+    /**
+     * Delete a snapshot.
+     *
+     * @param snapshotId - Snapshot UUID.
+     */
+    async deleteSnapshot(snapshotId) {
+        const url = `${this._baseUrl}/snapshots/${encodeURIComponent(snapshotId)}`;
+        const response = await this._fetch(url, { method: "DELETE" });
+        if (!response.ok) {
+            await (0, helpers_js_1.handleClientHttpError)(response);
+        }
+    }
+    /**
+     * Poll until a snapshot reaches "ready" or "failed" status.
+     *
+     * @param snapshotId - Snapshot UUID.
+     * @param options - Polling options (timeout, pollInterval).
+     * @returns Snapshot in "ready" status.
+     */
+    async waitForSnapshot(snapshotId, options = {}) {
+        const { timeout = 300, pollInterval = 2.0, signal } = options;
+        const deadline = Date.now() + timeout * 1000;
+        let lastStatus = "building";
+        while (Date.now() < deadline) {
+            signal?.throwIfAborted();
+            const snapshot = await this.getSnapshot(snapshotId, { signal });
+            lastStatus = snapshot.status;
+            if (snapshot.status === "ready") {
+                return snapshot;
+            }
+            if (snapshot.status === "failed") {
+                throw new errors_js_1.LangSmithResourceCreationError(snapshot.status_message ?? `Snapshot '${snapshotId}' build failed`, "snapshot");
+            }
+            // Cap sleep to remaining time + jitter
+            const remaining = deadline - Date.now();
+            const jitter = pollInterval * 200 * (Math.random() - 0.5); // ±10%
+            const delay = Math.min(pollInterval * 1000 + jitter, remaining);
+            if (delay > 0) {
+                await sleepWithSignal(delay, signal);
+            }
+        }
+        throw new errors_js_1.LangSmithResourceTimeoutError(`Snapshot '${snapshotId}' did not become ready within ${timeout}s`, "snapshot", lastStatus);
+    }
+    /**
+     * Returns a string representation of the SandboxClient instance.
+     * This method is called when the object is converted to a string
+     * or logged, ensuring sensitive information like API keys is not exposed.
+     *
+     * @returns A string representation of the SandboxClient.
+     */
+    toString() {
+        return `[LangSmithSandboxClient apiEndpoint=${JSON.stringify(this._baseUrl)}]`;
+    }
+    /**
+     * Custom inspect method for Node.js.
+     * This method is called when the object is inspected in the Node.js REPL
+     * or with console.log, ensuring sensitive information like API keys is not exposed.
+     *
+     * @returns A string representation of the SandboxClient for inspection.
+     */
+    [Symbol.for("nodejs.util.inspect.custom")]() {
+        return this.toString();
+    }
 }
 exports.SandboxClient = SandboxClient;