feat: add Volume CRUD operations to SDKs (#1126)

Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
Co-authored-by: Joe Lombrozo <joe.lombrozo@e2b.dev>

Author: 3 people

.changeset/shiny-wasps-find.md

@@ -0,0 +1,6 @@
+---
+'@e2b/python-sdk': minor
+'e2b': minor
+---
+
+added volumes support to the SDKs

packages/js-sdk/package.json

@@ -29,9 +29,10 @@
     "example": "tsx example.mts",
     "test": "vitest run",
     "generate": "npm-run-all generate:* && pnpm run format",
-    "generate:api": "python ./../../spec/remove_extra_tags.py sandboxes snapshots templates tags auth && openapi-typescript ../../spec/openapi_generated.yml -x api_key --array-length --alphabetize --default-non-nullable false --output src/api/schema.gen.ts",
+    "generate:api": "python ./../../spec/remove_extra_tags.py sandboxes snapshots templates tags auth volumes && openapi-typescript ../../spec/openapi_generated.yml -x api_key --array-length --alphabetize --default-non-nullable false --output src/api/schema.gen.ts",
     "generate:envd": "cd ../../spec/envd && buf generate --template buf-js.gen.yaml\n",
     "generate:envd-api": "openapi-typescript ../../spec/envd/envd.yaml -x api_key --array-length --alphabetize --output src/envd/schema.gen.ts",
+    "generate:volume-api": "openapi-typescript ../../spec/openapi-volumecontent.yml -x api_key --array-length --alphabetize --output src/volume/schema.gen.ts",
     "generate:mcp": "json2ts -i ./../../spec/mcp-server.json -o src/sandbox/mcp.d.ts --unreachableDefinitions --style.singleQuote --no-style.semi",
     "check-deps": "knip",
     "pretest": "npx playwright install --with-deps chromium",
@@ -56,7 +57,8 @@
     "eslint": "^8.57.1",
     "json-schema-to-typescript": "^15.0.4",
     "knip": "^5.43.6",
-    "msw": "^2.12.3",
+    "msw": "^2.12.10",
+    "npm-check-updates": "^16.14.20",
     "npm-run-all": "^4.1.5",
     "openapi-typescript": "^7.9.1",
     "playwright": "^1.55.1",

packages/js-sdk/src/api/schema.gen.ts

@@ -162,3 +162,15 @@ export class FileUploadError extends BuildError {
     this.name = 'FileUploadError'
   }
 }
+
+/**
+ * Base class for all volume errors.
+ *
+ * Thrown when general volume errors occur.
+ */
+export class VolumeError extends Error {
+  constructor(message: string) {
+    super(message)
+    this.name = 'VolumeError'
+  }
+}

packages/js-sdk/src/errors.ts

@@ -18,6 +18,7 @@ export {
   RateLimitError,
   BuildError,
   FileUploadError,
+  VolumeError,
 } from './errors'
 export type { Logger } from './logs'
 
@@ -90,6 +91,17 @@ export type {
   GitStatus,
 } from './sandbox/git'
 
+export { Volume, VolumeFileType } from './volume'
+export type {
+  VolumeInfo,
+  VolumeAndToken,
+  VolumeEntryStat,
+  VolumeMetadataOptions,
+  VolumeWriteOptions,
+  VolumeApiOpts,
+  VolumeConnectionConfig,
+} from './volume'
+
 export { Sandbox }
 import { Sandbox } from './sandbox'
 

packages/js-sdk/src/index.ts

@@ -7,6 +7,7 @@ import {
 import { compareVersions } from 'compare-versions'
 import { SandboxNotFoundError, TemplateError } from '../errors'
 import { timeoutToSeconds } from '../utils'
+import type { Volume } from '../volume'
 import type { McpServer as BaseMcpServer } from './mcp'
 
 /**
@@ -156,6 +157,16 @@ export interface SandboxOpts extends ConnectionOpts {
    */
   network?: SandboxNetworkOpts
 
+  /**
+   * Volume mounts for the sandbox.
+   *
+   * The keys are mount paths inside the sandbox and the values are either
+   * a `Volume` instance or a string representing the volume name.
+   *
+   * @default undefined
+   */
+  volumeMounts?: Record<string, Volume | string>
+
   /**
    * Sandbox URL. Used for local development
    */
@@ -337,6 +348,11 @@ export interface SandboxInfo {
    * Sandbox lifecycle configuration.
    */
   lifecycle?: SandboxInfoLifecycle
+
+  /**
+   * Volume mounts for the sandbox.
+   */
+  volumeMounts?: Array<{ name: string; path: string }>
 }
 
 /**
@@ -602,6 +618,7 @@ export class SandboxApi {
           }
         : undefined,
       sandboxDomain: res.data.domain || undefined,
+      volumeMounts: res.data.volumeMounts ?? [],
     }
   }
 
@@ -775,6 +792,15 @@ export class SandboxApi {
         : {}),
     }
 
+    if (opts?.volumeMounts) {
+      body.volumeMounts = Object.entries(opts.volumeMounts).map(
+        ([mountPath, vol]) => ({
+          name: typeof vol === 'string' ? vol : vol.name,
+          path: mountPath,
+        })
+      )
+    }
+
     const res = await client.api.POST('/sandboxes', {
       body,
       signal: config.getSignal(opts?.requestTimeoutMs),
@@ -959,6 +985,7 @@ export class SandboxPaginator extends BasePaginator<SandboxInfo> {
         cpuCount: sandbox.cpuCount,
         memoryMB: sandbox.memoryMB,
         envdVersion: sandbox.envdVersion,
+        volumeMounts: sandbox.volumeMounts ?? [],
       })
     )
   }