Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

[skip ci] Release new versions

github-actions[bot]5d4fb0d8e77b
diff --git a/.changeset/rare-planets-smoke.md b/.changeset/rare-planets-smoke.md
deleted file mode 100644
index 6cbc09754..000000000
--- a/.changeset/rare-planets-smoke.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-'e2b': patch
----
-
-Add explicit content header to fix bug in bun when uploading files
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/errors/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/errors/page.mdx
new file mode 100644
index 000000000..f989f00a5
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/errors/page.mdx
@@ -0,0 +1,231 @@
+# errors
+
+## Classes
+
+### AuthenticationError
+
+Thrown when authentication fails.
+
+#### Constructors
+
+##### new AuthenticationError()
+
+> **new AuthenticationError**(`message`): `AuthenticationError`
+
+###### Parameters
+
+• **message**: `any`
+
+###### Returns
+
+`AuthenticationError`
+
+###### Defined in
+
+errors.ts:72
+
+***
+
+### InvalidArgumentError
+
+Thrown when an invalid argument is provided.
+
+#### Constructors
+
+##### new InvalidArgumentError()
+
+> **new InvalidArgumentError**(`message`): `InvalidArgumentError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`InvalidArgumentError`
+
+###### Defined in
+
+errors.ts:42
+
+***
+
+### NotEnoughSpaceError
+
+Thrown when there is not enough disk space.
+
+#### Constructors
+
+##### new NotEnoughSpaceError()
+
+> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`NotEnoughSpaceError`
+
+###### Defined in
+
+errors.ts:52
+
+***
+
+### NotFoundError
+
+Thrown when a resource is not found.
+
+#### Constructors
+
+##### new NotFoundError()
+
+> **new NotFoundError**(`message`): `NotFoundError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`NotFoundError`
+
+###### Defined in
+
+errors.ts:62
+
+***
+
+### RateLimitError
+
+Thrown when the API rate limit is exceeded.
+
+#### Constructors
+
+##### new RateLimitError()
+
+> **new RateLimitError**(`message`): `RateLimitError`
+
+###### Parameters
+
+• **message**: `any`
+
+###### Returns
+
+`RateLimitError`
+
+###### Defined in
+
+errors.ts:92
+
+***
+
+### SandboxError
+
+Base class for all sandbox errors.
+
+Thrown when general sandbox errors occur.
+
+#### Extended by
+
+- `TimeoutError`
+- `InvalidArgumentError`
+- `NotEnoughSpaceError`
+- `NotFoundError`
+- `AuthenticationError`
+- `TemplateError`
+- `RateLimitError`
+
+#### Constructors
+
+##### new SandboxError()
+
+> **new SandboxError**(`message`): `SandboxError`
+
+###### Parameters
+
+• **message**: `any`
+
+###### Returns
+
+`SandboxError`
+
+###### Defined in
+
+errors.ts:14
+
+***
+
+### TemplateError
+
+Thrown when the template uses old envd version. It isn't compatible with the new SDK.
+
+#### Constructors
+
+##### new TemplateError()
+
+> **new TemplateError**(`message`): `TemplateError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`TemplateError`
+
+###### Defined in
+
+errors.ts:82
+
+***
+
+### TimeoutError
+
+Thrown when a timeout error occurs.
+
+The [unavailable] error type is caused by sandbox timeout.
+
+The [canceled] error type is caused by exceeding request timeout.
+
+The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc.
+
+The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly.
+
+#### Constructors
+
+##### new TimeoutError()
+
+> **new TimeoutError**(`message`): `TimeoutError`
+
+###### Parameters
+
+• **message**: `string`
+
+###### Returns
+
+`TimeoutError`
+
+###### Defined in
+
+errors.ts:32
+
+## Functions
+
+### formatSandboxTimeoutError()
+
+> **formatSandboxTimeoutError**(`message`): `TimeoutError`
+
+#### Parameters
+
+• **message**: `string`
+
+#### Returns
+
+`TimeoutError`
+
+#### Defined in
+
+errors.ts:2
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/filesystem/page.mdx
new file mode 100644
index 000000000..82311909f
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/filesystem/page.mdx
@@ -0,0 +1,518 @@
+# sandbox/filesystem
+
+## Enumerations
+
+### FileType
+
+Sandbox filesystem object type.
+
+#### Enumeration Members
+
+##### DIR
+
+> **DIR**: `"dir"`
+
+Filesystem object is a directory.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:55
+
+##### FILE
+
+> **FILE**: `"file"`
+
+Filesystem object is a file.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:51
+
+## Classes
+
+### Filesystem
+
+Module for interacting with the sandbox filesystem.
+
+#### Constructors
+
+##### new Filesystem()
+
+> **new Filesystem**(`transport`, `envdApi`, `connectionConfig`): `Filesystem`
+
+###### Parameters
+
+• **transport**: `Transport`
+
+• **envdApi**: `EnvdApiClient`
+
+• **connectionConfig**: `ConnectionConfig`
+
+###### Returns
+
+`Filesystem`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:104
+
+#### Methods
+
+##### exists()
+
+> **exists**(`path`, `opts`?): `Promise`\<`boolean`\>
+
+Check if a file or a directory exists.
+
+###### Parameters
+
+• **path**: `string`
+
+path to a file or a directory
+
+• **opts?**: `FilesystemRequestOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the file or directory exists, `false` otherwise
+
+###### Defined in
+
+sandbox/filesystem/index.ts:402
+
+##### list()
+
+> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\>
+
+List entries in a directory.
+
+###### Parameters
+
+• **path**: `string`
+
+path to the directory.
+
+• **opts?**: `FilesystemRequestOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`EntryInfo`[]\>
+
+list of entries in the sandbox filesystem directory.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:273
+
+##### makeDir()
+
+> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\>
+
+Create a new directory and all directories along the way if needed on the specified path.
+
+###### Parameters
+
+• **path**: `string`
+
+path to a new directory. For example '/dirA/dirB' when creating 'dirB'.
+
+• **opts?**: `FilesystemRequestOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the directory was created, `false` if it already exists.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:311
+
+##### read()
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`string`\>
+
+Read file content as a `string`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+• **path**: `string`
+
+path to the file.
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`string`\>
+
+file content as string
+
+###### Defined in
+
+sandbox/filesystem/index.ts:123
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\>
+
+Read file content as a `Uint8Array`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+• **path**: `string`
+
+path to the file.
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`Uint8Array`\>
+
+file content as `Uint8Array`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:138
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`Blob`\>
+
+Read file content as a `Blob`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+• **path**: `string`
+
+path to the file.
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`Blob`\>
+
+file content as `Blob`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:153
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\>
+
+Read file content as a `ReadableStream`.
+
+You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type.
+
+###### Parameters
+
+• **path**: `string`
+
+path to the file.
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`ReadableStream`\<`Uint8Array`\>\>
+
+file content as `ReadableStream`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:168
+
+##### remove()
+
+> **remove**(`path`, `opts`?): `Promise`\<`void`\>
+
+Remove a file or directory.
+
+###### Parameters
+
+• **path**: `string`
+
+path to a file or directory.
+
+• **opts?**: `FilesystemRequestOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:380
+
+##### rename()
+
+> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\>
+
+Rename a file or directory.
+
+###### Parameters
+
+• **oldPath**: `string`
+
+path to the file or directory to rename.
+
+• **newPath**: `string`
+
+new path for the file or directory.
+
+• **opts?**: `FilesystemRequestOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+information about renamed file or directory.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:342
+
+##### watchDir()
+
+> **watchDir**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\>
+
+Start watching a directory for filesystem events.
+
+###### Parameters
+
+• **path**: `string`
+
+path to directory to watch.
+
+• **onEvent**
+
+callback to call when an event in the directory occurs.
+
+• **opts?**: `WatchOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`WatchHandle`\>
+
+`WatchHandle` object for stopping watching directory.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:433
+
+##### write()
+
+> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\>
+
+Write content to a file.
+
+Writing to a file that doesn't exist creates the file.
+
+Writing to a file that already exists overwrites the file.
+
+Writing to a file at path that doesn't exist creates the necessary directories.
+
+###### Parameters
+
+• **path**: `string`
+
+path to file.
+
+• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\>
+
+data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`.
+
+• **opts?**: `FilesystemRequestOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+information about the written file
+
+###### Defined in
+
+sandbox/filesystem/index.ts:224
+
+## Interfaces
+
+### EntryInfo
+
+Sandbox filesystem object information.
+
+#### Properties
+
+##### name
+
+> **name**: `string`
+
+Name of the filesystem object.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:33
+
+##### path
+
+> **path**: `string`
+
+Path to the filesystem object.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:41
+
+##### type?
+
+> `optional` **type**: `FileType`
+
+Type of the filesystem object.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:37
+
+***
+
+### FilesystemRequestOpts
+
+Options for the sandbox filesystem operations.
+
+#### Extended by
+
+- `WatchOpts`
+
+#### Properties
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+30_000 // 30 seconds
+```
+
+###### Defined in
+
+connectionConfig.ts:42
+
+##### user?
+
+> `optional` **user**: `Username`
+
+User to use for the operation in the sandbox.
+This affects the resolution of relative paths and ownership of the created filesystem objects.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:76
+
+***
+
+### WatchOpts
+
+Options for watching a directory.
+
+#### Properties
+
+##### onExit()?
+
+> `optional` **onExit**: (`err`?) => `void` \| `Promise`\<`void`\>
+
+Callback to call when the watch operation stops.
+
+###### Parameters
+
+• **err?**: `Error`
+
+###### Returns
+
+`void` \| `Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:93
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+30_000 // 30 seconds
+```
+
+###### Defined in
+
+connectionConfig.ts:42
+
+##### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Timeout for the watch operation in **milliseconds**.
+You can pass `0` to disable the timeout.
+
+###### Default
+
+```ts
+60_000 // 60 seconds
+```
+
+###### Defined in
+
+sandbox/filesystem/index.ts:89
+
+##### user?
+
+> `optional` **user**: `Username`
+
+User to use for the operation in the sandbox.
+This affects the resolution of relative paths and ownership of the created filesystem objects.
+
+###### Defined in
+
+sandbox/filesystem/index.ts:76
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/sandbox/page.mdx
new file mode 100644
index 000000000..6c4cae338
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/sandbox/page.mdx
@@ -0,0 +1,581 @@
+# sandbox
+
+## Classes
+
+### Sandbox
+
+E2B cloud sandbox is a secure and isolated cloud environment.
+
+The sandbox allows you to:
+- Access Linux OS
+- Create, list, and delete files and directories
+- Run commands
+- Run isolated code
+- Access the internet
+
+Check docs here.
+
+Use Sandbox.create to create a new sandbox.
+
+#### Example
+
+```ts
+import { Sandbox } from 'e2b'
+
+const sandbox = await Sandbox.create()
+```
+
+#### Properties
+
+##### commands
+
+> `readonly` **commands**: `Commands`
+
+Module for running commands in the sandbox
+
+###### Defined in
+
+sandbox/index.ts:74
+
+##### files
+
+> `readonly` **files**: `Filesystem`
+
+Module for interacting with the sandbox filesystem
+
+###### Defined in
+
+sandbox/index.ts:70
+
+##### pty
+
+> `readonly` **pty**: `Pty`
+
+Module for interacting with the sandbox pseudo-terminals
+
+###### Defined in
+
+sandbox/index.ts:78
+
+##### sandboxId
+
+> `readonly` **sandboxId**: `string`
+
+Unique identifier of the sandbox.
+
+###### Defined in
+
+sandbox/index.ts:83
+
+#### Methods
+
+##### downloadUrl()
+
+> **downloadUrl**(`path`): `string`
+
+Get the URL to download a file from the sandbox.
+
+###### Parameters
+
+• **path**: `string`
+
+path to the file to download.
+
+###### Returns
+
+`string`
+
+URL for downloading file.
+
+###### Defined in
+
+sandbox/index.ts:339
+
+##### getHost()
+
+> **getHost**(`port`): `string`
+
+Get the host address for the specified sandbox port.
+You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket.
+
+###### Parameters
+
+• **port**: `number`
+
+number of the port in the sandbox.
+
+###### Returns
+
+`string`
+
+host address of the sandbox port.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+// Start an HTTP server
+await sandbox.commands.exec('python3 -m http.server 3000')
+// Get the hostname of the HTTP server
+const serverURL = sandbox.getHost(3000)
+``
+
+###### Defined in
+
+sandbox/index.ts:237
+
+##### isRunning()
+
+> **isRunning**(`opts`?): `Promise`\<`boolean`\>
+
+Check if the sandbox is running.
+
+###### Parameters
+
+• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the sandbox is running, `false` otherwise.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+await sandbox.isRunning() // Returns true
+
+await sandbox.kill()
+await sandbox.isRunning() // Returns false
+```
+
+###### Defined in
+
+sandbox/index.ts:259
+
+##### kill()
+
+> **kill**(`opts`?): `Promise`\<`void`\>
+
+Kill the sandbox.
+
+###### Parameters
+
+• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\>
+
+connection options.
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/index.ts:310
+
+##### setTimeout()
+
+> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\>
+
+Set the timeout of the sandbox.
+After the timeout expires the sandbox will be automatically killed.
+
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`.
+Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users.
+
+###### Parameters
+
+• **timeoutMs**: `number`
+
+timeout in **milliseconds**.
+
+• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\>
+
+connection options.
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/index.ts:290
+
+##### uploadUrl()
+
+> **uploadUrl**(`path`?): `string`
+
+Get the URL to upload a file to the sandbox.
+
+You have to send a POST request to this URL with the file as multipart/form-data.
+
+###### Parameters
+
+• **path?**: `string`
+
+the directory where to upload the file, defaults to user's home directory.
+
+###### Returns
+
+`string`
+
+URL for uploading file.
+
+###### Defined in
+
+sandbox/index.ts:328
+
+##### connect()
+
+> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+Connect to an existing sandbox.
+With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **sandboxId**: `string`
+
+sandbox ID.
+
+• **opts?**: `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\>
+
+connection options.
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+sandbox instance for the existing sandbox.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+const sandboxId = sandbox.sandboxId
+
+// Connect to the same sandbox.
+const sameSandbox = await Sandbox.connect(sandboxId)
+```
+
+###### Defined in
+
+sandbox/index.ts:209
+
+##### create()
+
+###### create(this, opts)
+
+> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+Create a new sandbox from the default `base` sandbox template.
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **opts?**: `SandboxOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+sandbox instance for the new sandbox.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create()
+```
+
+###### Constructs
+
+Sandbox
+
+###### Defined in
+
+sandbox/index.ts:143
+
+###### create(this, template, opts)
+
+> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+Create a new sandbox from the specified sandbox template.
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **template**: `string`
+
+sandbox template name or ID.
+
+• **opts?**: `SandboxOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+sandbox instance for the new sandbox.
+
+###### Example
+
+```ts
+const sandbox = await Sandbox.create('<template-name-or-id>')
+```
+
+###### Constructs
+
+Sandbox
+
+###### Defined in
+
+sandbox/index.ts:162
+
+##### kill()
+
+> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\>
+
+Kill the sandbox specified by sandbox ID.
+
+###### Parameters
+
+• **sandboxId**: `string`
+
+sandbox ID.
+
+• **opts?**: `SandboxApiOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the sandbox was found and killed, `false` otherwise.
+
+###### Defined in
+
+sandbox/sandboxApi.ts:55
+
+##### list()
+
+> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\>
+
+List all running sandboxes.
+
+###### Parameters
+
+• **opts?**: `SandboxApiOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`SandboxInfo`[]\>
+
+list of running sandboxes.
+
+###### Defined in
+
+sandbox/sandboxApi.ts:90
+
+##### setTimeout()
+
+> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\>
+
+Set the timeout of the specified sandbox.
+After the timeout expires the sandbox will be automatically killed.
+
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout.
+
+Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users.
+
+###### Parameters
+
+• **sandboxId**: `string`
+
+sandbox ID.
+
+• **timeoutMs**: `number`
+
+timeout in **milliseconds**.
+
+• **opts?**: `SandboxApiOpts`
+
+connection options.
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/sandboxApi.ts:129
+
+## Interfaces
+
+### SandboxOpts
+
+Options for creating a new Sandbox.
+
+#### Properties
+
+##### accessToken?
+
+> `optional` **accessToken**: `string`
+
+E2B access token to use for authentication.
+
+###### Default
+
+```ts
+E2B_ACCESS_TOKEN // environment variable
+```
+
+###### Defined in
+
+connectionConfig.ts:24
+
+##### apiKey?
+
+> `optional` **apiKey**: `string`
+
+E2B API key to use for authentication.
+
+###### Default
+
+```ts
+E2B_API_KEY // environment variable
+```
+
+###### Defined in
+
+connectionConfig.ts:18
+
+##### debug?
+
+> `optional` **debug**: `boolean`
+
+**`Internal`**
+
+If true the SDK starts in the debug mode and connects to the local envd API server.
+
+###### Default
+
+E2B_DEBUG // environment variable or `false`
+
+###### Defined in
+
+connectionConfig.ts:36
+
+##### domain?
+
+> `optional` **domain**: `string`
+
+Domain to use for the API.
+
+###### Default
+
+E2B_DOMAIN // environment variable or `e2b.dev`
+
+###### Defined in
+
+connectionConfig.ts:30
+
+##### envs?
+
+> `optional` **envs**: `Record`\<`string`, `string`\>
+
+Custom environment variables for the sandbox.
+
+Used when executing commands and code in the sandbox.
+Can be overridden with the `envs` argument when executing commands or code.
+
+###### Default
+
+```ts
+{}
+```
+
+###### Defined in
+
+sandbox/index.ts:32
+
+##### logger?
+
+> `optional` **logger**: `Logger`
+
+Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console.
+
+###### Defined in
+
+connectionConfig.ts:46
+
+##### metadata?
+
+> `optional` **metadata**: `Record`\<`string`, `string`\>
+
+Custom metadata for the sandbox.
+
+###### Default
+
+```ts
+{}
+```
+
+###### Defined in
+
+sandbox/index.ts:23
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+Timeout for requests to the API in **milliseconds**.
+
+###### Default
+
+```ts
+30_000 // 30 seconds
+```
+
+###### Defined in
+
+connectionConfig.ts:42
+
+##### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+Timeout for the sandbox in **milliseconds**.
+Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users.
+
+###### Default
+
+```ts
+300_000 // 5 minutes
+```
+
+###### Defined in
+
+sandbox/index.ts:39
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_async/page.mdx
index 57bbc0ea5..2583bcc1d 100644
--- a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_async/page.mdx
+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_async/page.mdx
@@ -1,549 +1,489 @@
-
-
-## AsyncSandbox
+## Commands
```python
-class AsyncSandbox(SandboxSetup, SandboxApi)
+class Commands()
```
-E2B cloud sandbox is a secure and isolated cloud environment.
-
-The sandbox allows you to:
-- Access Linux OS
-- Create, list, and delete files and directories
-- Run commands
-- Run isolated code
-- Access the internet
-
-Check docs [here](https://e2b.dev/docs).
+Module for executing commands in the sandbox.
-Use the `AsyncSandbox.create()` to create a new sandbox.
-**Example**:
+#### list
```python
-from e2b import AsyncSandbox
-
-sandbox = await AsyncSandbox.create()
+async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]
```
+Lists all running commands and PTY sessions.
-#### files
+**Arguments**:
-```python
-@property
-def files() -> Filesystem
-```
+- `request_timeout`: Timeout for the request in **seconds**
-Module for interacting with the sandbox filesystem.
+**Returns**:
+
+List of running commands and PTY sessions
-#### commands
+#### kill
```python
-@property
-def commands() -> Commands
+async def kill(pid: int, request_timeout: Optional[float] = None) -> bool
```
-Module for running commands in the sandbox.
+Kill a running command specified by its process ID.
+It uses `SIGKILL` signal to kill the command.
-#### pty
+**Arguments**:
-```python
-@property
-def pty() -> Pty
-```
+- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()`
+- `request_timeout`: Timeout for the request in **seconds**
-Module for interacting with the sandbox pseudo-terminal.
+**Returns**:
+`True` if the command was killed, `False` if the command was not found
-#### sandbox\_id
+
+#### send\_stdin
```python
-@property
-def sandbox_id() -> str
+async def send_stdin(pid: int,
+ data: str,
+ request_timeout: Optional[float] = None) -> None
```
-Unique identifier of the sandbox.
-
-
-#### \_\_init\_\_
+Send data to command stdin.
-```python
-def __init__(**opts: Unpack[AsyncSandboxOpts])
-```
+:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`.
+:param data: Data to send to the command
+:param request_timeout: Timeout for the request in **seconds**
-Use `AsyncSandbox.create()` to create a new sandbox instead.
-#### is\_running
+#### run
```python
-async def is_running(request_timeout: Optional[float] = None) -> bool
+@overload
+async def run(cmd: str,
+ background: Union[Literal[False], None] = None,
+ envs: Optional[Dict[str, str]] = None,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ on_stdout: Optional[OutputHandler[Stdout]] = None,
+ on_stderr: Optional[OutputHandler[Stderr]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> CommandResult
```
-Check if the sandbox is running.
+Start a new command and wait until it finishes executing.
**Arguments**:
+- `cmd`: Command to execute
+- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background
+- `envs`: Environment variables used for the command
+- `user`: User to run the command as
+- `cwd`: Working directory to run the command
+- `on_stdout`: Callback for command stdout output
+- `on_stderr`: Callback for command stderr output
+- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`True` if the sandbox is running, `False` otherwise
-Example
-```python
-sandbox = await AsyncSandbox.create()
-await sandbox.is_running() # Returns True
-
-await sandbox.kill()
-await sandbox.is_running() # Returns False
-```
+`CommandResult` result of the command execution
-#### create
+#### run
```python
-@classmethod
-async def create(cls,
- template: Optional[str] = None,
- timeout: Optional[int] = None,
- metadata: Optional[Dict[str, str]] = None,
- envs: Optional[Dict[str, str]] = None,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- request_timeout: Optional[float] = None)
+@overload
+async def run(cmd: str,
+ background: Literal[True],
+ envs: Optional[Dict[str, str]] = None,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ on_stdout: Optional[OutputHandler[Stdout]] = None,
+ on_stderr: Optional[OutputHandler[Stderr]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> AsyncCommandHandle
```
-Create a new sandbox.
-
-By default, the sandbox is created from the default `base` sandbox template.
+Start a new command and return a handle to interact with it.
**Arguments**:
-- `template`: Sandbox template name or ID
-- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
-- `metadata`: Custom metadata for the sandbox
-- `envs`: Custom environment variables for the sandbox
-- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+- `cmd`: Command to execute
+- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background**
+- `envs`: Environment variables used for the command
+- `user`: User to run the command as
+- `cwd`: Working directory to run the command
+- `on_stdout`: Callback for command stdout output
+- `on_stderr`: Callback for command stderr output
+- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-sandbox instance for the new sandbox
-Use this method instead of using the constructor to create a new sandbox.
+`AsyncCommandHandle` handle to interact with the running command
#### connect
```python
-@classmethod
-async def connect(cls,
- sandbox_id: str,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None)
+async def connect(
+ pid: int,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None,
+ on_stdout: Optional[OutputHandler[Stdout]] = None,
+ on_stderr: Optional[OutputHandler[Stderr]] = None
+) -> AsyncCommandHandle
```
-Connect to an existing sandbox.
+Connects to a running command.
-With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
+You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results.
**Arguments**:
-- `sandbox_id`: Sandbox ID
-- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()`
+- `request_timeout`: Request timeout in **seconds**
+- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+- `on_stdout`: Callback for command stdout output
+- `on_stderr`: Callback for command stderr output
**Returns**:
-sandbox instance for the existing sandbox
-@example
-```python
-sandbox = await AsyncSandbox.create()
-sandbox_id = sandbox.sandbox_id
+`AsyncCommandHandle` handle to interact with the running command
-same_sandbox = await AsyncSandbox.connect(sandbox_id)
-#### kill
+
+## AsyncCommandHandle
```python
-@overload
-async def kill(request_timeout: Optional[float] = None) -> bool
+class AsyncCommandHandle()
```
-Kill the sandbox.
-
-**Arguments**:
-
-- `request_timeout`: Timeout for the request in **seconds**
-
-**Returns**:
+Command execution handle.
-`True` if the sandbox was killed, `False` if the sandbox was not found
+It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.
-#### kill
+#### pid
```python
-@overload
-@staticmethod
-async def kill(sandbox_id: str,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- request_timeout: Optional[float] = None) -> bool
+@property
+def pid()
```
-Kill the sandbox specified by sandbox ID.
-
-**Arguments**:
-
-- `sandbox_id`: Sandbox ID
-- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
-- `request_timeout`: Timeout for the request in **seconds**
-
-**Returns**:
-
-`True` if the sandbox was killed, `False` if the sandbox was not found
+Command process ID.
-#### set\_timeout
+#### stdout
```python
-@overload
-async def set_timeout(timeout: int,
- request_timeout: Optional[float] = None) -> None
+@property
+def stdout()
```
-Set the timeout of the sandbox.
+Command stdout output.
-After the timeout expires the sandbox will be automatically killed.
-This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
-Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
+#### stderr
-**Arguments**:
+```python
+@property
+def stderr()
+```
-- `timeout`: Timeout for the sandbox in **seconds**
-- `request_timeout`: Timeout for the request in **seconds**
+Command stderr output.
-#### set\_timeout
+#### error
```python
-@overload
-@staticmethod
-async def set_timeout(sandbox_id: str,
- timeout: int,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- request_timeout: Optional[float] = None) -> None
+@property
+def error()
```
-Set the timeout of the specified sandbox.
+Command execution error message.
-After the timeout expires the sandbox will be automatically killed.
-This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
-Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
+#### exit\_code
-**Arguments**:
+```python
+@property
+def exit_code()
+```
-- `sandbox_id`: Sandbox ID
-- `timeout`: Timeout for the sandbox in **seconds**
-- `request_timeout`: Timeout for the request in **seconds**
+Command execution exit code.
+`0` if the command finished successfully.
+It is `None` if the command is still running.
-## Filesystem
+#### disconnect
```python
-class Filesystem()
+async def disconnect() -> None
```
-Module for interacting with the filesystem in the sandbox.
+Disconnects from the command.
+The command is not killed, but SDK stops receiving events from the command.
+You can reconnect to the command using `sandbox.commands.connect` method.
-#### read
+
+#### wait
```python
-@overload
-async def read(path: str,
- format: Literal["text"] = "text",
- user: Username = "user",
- request_timeout: Optional[float] = None) -> str
+async def wait() -> CommandResult
```
-Read file content as a `str`.
-
-**Arguments**:
+Wait for the command to finish and return the result.
-- `path`: Path to the file
-- `user`: Run the operation as this user
-- `format`: Format of the file content—`text` by default
-- `request_timeout`: Timeout for the request in **seconds**
+If the command exits with a non-zero exit code, it throws a `CommandExitException`.
**Returns**:
-File content as a `str`
+`CommandResult` result of command execution
-#### read
+#### kill
```python
-@overload
-async def read(path: str,
- format: Literal["bytes"],
- user: Username = "user",
- request_timeout: Optional[float] = None) -> bytearray
+async def kill() -> bool
```
-Read file content as a `bytearray`.
-
-**Arguments**:
+Kills the command.
-- `path`: Path to the file
-- `user`: Run the operation as this user
-- `format`: Format of the file content—`bytes`
-- `request_timeout`: Timeout for the request in **seconds**
+It uses `SIGKILL` signal to kill the command
**Returns**:
-File content as a `bytearray`
-
-
-#### read
+`True` if the command was killed successfully, `False` if the command was not found
-```python
-@overload
-async def read(
- path: str,
- format: Literal["stream"],
- user: Username = "user",
- request_timeout: Optional[float] = None) -> AsyncIterator[bytes]
-```
-Read file content as a `AsyncIterator[bytes]`.
-**Arguments**:
-- `path`: Path to the file
-- `user`: Run the operation as this user
-- `format`: Format of the file content—`stream`
-- `request_timeout`: Timeout for the request in **seconds**
+## Pty
-**Returns**:
+```python
+class Pty()
+```
-File content as an `AsyncIterator[bytes]`
+Module for interacting with PTYs (pseudo-terminals) in the sandbox.
-#### write
+#### kill
```python
-async def write(path: str,
- data: Union[str, bytes, IO],
- user: Username = "user",
- request_timeout: Optional[float] = None) -> EntryInfo
+async def kill(pid: int, request_timeout: Optional[float] = None) -> bool
```
-Write content to a file on the path.
-
-Writing to a file that doesn't exist creates the file.
-
-Writing to a file that already exists overwrites the file.
-
-Writing to a file at path that doesn't exist creates the necessary directories.
+Kill PTY.
**Arguments**:
-- `path`: Path to the file
-- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`.
-- `user`: Run the operation as this user
+- `pid`: Process ID of the PTY
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-Information about the written file
+`true` if the PTY was killed, `false` if the PTY was not found
-#### list
+#### send\_stdin
```python
-async def list(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> List[EntryInfo]
+async def send_stdin(pid: int,
+ data: bytes,
+ request_timeout: Optional[float] = None) -> None
```
-List entries in a directory.
+Send input to a PTY.
**Arguments**:
-- `path`: Path to the directory
-- `user`: Run the operation as this user
+- `pid`: Process ID of the PTY
+- `data`: Input data to send
- `request_timeout`: Timeout for the request in **seconds**
-**Returns**:
-
-List of entries in the directory
-
-#### exists
+#### create
```python
-async def exists(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> bool
+async def create(
+ size: PtySize,
+ on_data: OutputHandler[PtyOutput],
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ envs: Optional[Dict[str, str]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> AsyncCommandHandle
```
-Check if a file or a directory exists.
+Start a new PTY (pseudo-terminal).
**Arguments**:
-- `path`: Path to a file or a directory
-- `user`: Run the operation as this user
+- `size`: Size of the PTY
+- `on_data`: Callback to handle PTY data
+- `user`: User to use for the PTY
+- `cwd`: Working directory for the PTY
+- `envs`: Environment variables for the PTY
+- `timeout`: Timeout for the PTY in **seconds**
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`True` if the file or directory exists, `False` otherwise
+Handle to interact with the PTY
-#### remove
+#### resize
```python
-async def remove(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> None
+async def resize(pid: int,
+ size: PtySize,
+ request_timeout: Optional[float] = None)
```
-Remove a file or a directory.
+Resize PTY.
+
+Call this when the terminal window is resized and the number of columns and rows has changed.
**Arguments**:
-- `path`: Path to a file or a directory
-- `user`: Run the operation as this user
+- `pid`: Process ID of the PTY
+- `size`: New size of the PTY
- `request_timeout`: Timeout for the request in **seconds**
-#### rename
-
-```python
-async def rename(old_path: str,
- new_path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> EntryInfo
-```
-Rename a file or directory.
-**Arguments**:
-- `old_path`: Path to the file or directory to rename
-- `new_path`: New path to the file or directory
-- `user`: Run the operation as this user
-- `request_timeout`: Timeout for the request in **seconds**
-**Returns**:
+## SandboxApi
-Information about the renamed file or directory
+```python
+class SandboxApi(SandboxApiBase)
+```
-#### make\_dir
+#### list
```python
-async def make_dir(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> bool
+@classmethod
+async def list(cls,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ request_timeout: Optional[float] = None) -> List[SandboxInfo]
```
-Create a new directory and all directories along the way if needed on the specified path.
+List all running sandboxes.
**Arguments**:
-- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'.
-- `user`: Run the operation as this user
+- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`True` if the directory was created, `False` if the directory already exists
+List of running sandboxes
-#### watch\_dir
+
+
+## AsyncSandbox
```python
-async def watch_dir(path: str,
- on_event: OutputHandler[FilesystemEvent],
- on_exit: Optional[OutputHandler[Exception]] = None,
- user: Username = "user",
- request_timeout: Optional[float] = None,
- timeout: Optional[float] = 60) -> AsyncWatchHandle
+class AsyncSandbox(SandboxSetup, SandboxApi)
```
-Watch directory for filesystem events.
+E2B cloud sandbox is a secure and isolated cloud environment.
-**Arguments**:
+The sandbox allows you to:
+- Access Linux OS
+- Create, list, and delete files and directories
+- Run commands
+- Run isolated code
+- Access the internet
-- `path`: Path to a directory to watch
-- `on_event`: Callback to call on each event in the directory
-- `on_exit`: Callback to call when the watching ends
-- `user`: Run the operation as this user
-- `request_timeout`: Timeout for the request in **seconds**
-- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time
+Check docs [here](https://e2b.dev/docs).
-**Returns**:
+Use the `AsyncSandbox.create()` to create a new sandbox.
-`AsyncWatchHandle` object for stopping watching directory
+**Example**:
+```python
+from e2b import AsyncSandbox
+sandbox = await AsyncSandbox.create()
+```
-## AsyncWatchHandle
+#### files
```python
-class AsyncWatchHandle()
+@property
+def files() -> Filesystem
```
-Handle for watching a directory in the sandbox filesystem.
+Module for interacting with the sandbox filesystem.
-Use `.stop()` to stop watching the directory.
+#### commands
-#### stop
+```python
+@property
+def commands() -> Commands
+```
+
+Module for running commands in the sandbox.
+
+
+#### pty
```python
-async def stop()
+@property
+def pty() -> Pty
```
-Stop watching the directory.
+Module for interacting with the sandbox pseudo-terminal.
+
+
+#### sandbox\_id
+```python
+@property
+def sandbox_id() -> str
+```
+Unique identifier of the sandbox.
-## Commands
+#### \_\_init\_\_
```python
-class Commands()
+def __init__(**opts: Unpack[AsyncSandboxOpts])
```
-Module for executing commands in the sandbox.
+Use `AsyncSandbox.create()` to create a new sandbox instead.
-#### list
+#### is\_running
```python
-async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]
+async def is_running(request_timeout: Optional[float] = None) -> bool
```
-Lists all running commands and PTY sessions.
+Check if the sandbox is running.
**Arguments**:
@@ -551,374 +491,434 @@ Lists all running commands and PTY sessions.
**Returns**:
-List of running commands and PTY sessions
+`True` if the sandbox is running, `False` otherwise
+Example
+```python
+sandbox = await AsyncSandbox.create()
+await sandbox.is_running() # Returns True
+await sandbox.kill()
+await sandbox.is_running() # Returns False
+```
-#### kill
+
+#### create
```python
-async def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+@classmethod
+async def create(cls,
+ template: Optional[str] = None,
+ timeout: Optional[int] = None,
+ metadata: Optional[Dict[str, str]] = None,
+ envs: Optional[Dict[str, str]] = None,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ request_timeout: Optional[float] = None)
```
-Kill a running command specified by its process ID.
+Create a new sandbox.
-It uses `SIGKILL` signal to kill the command.
+By default, the sandbox is created from the default `base` sandbox template.
**Arguments**:
-- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()`
+- `template`: Sandbox template name or ID
+- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
+- `metadata`: Custom metadata for the sandbox
+- `envs`: Custom environment variables for the sandbox
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`True` if the command was killed, `False` if the command was not found
+sandbox instance for the new sandbox
+Use this method instead of using the constructor to create a new sandbox.
-#### send\_stdin
+#### connect
```python
-async def send_stdin(pid: int,
- data: str,
- request_timeout: Optional[float] = None) -> None
+@classmethod
+async def connect(cls,
+ sandbox_id: str,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None)
```
-Send data to command stdin.
+Connect to an existing sandbox.
-:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`.
-:param data: Data to send to the command
-:param request_timeout: Timeout for the request in **seconds**
+With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
+
+**Arguments**:
+- `sandbox_id`: Sandbox ID
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+**Returns**:
-#### run
+sandbox instance for the existing sandbox
+@example
+```python
+sandbox = await AsyncSandbox.create()
+sandbox_id = sandbox.sandbox_id
+
+same_sandbox = await AsyncSandbox.connect(sandbox_id)
+
+
+#### kill
```python
@overload
-async def run(cmd: str,
- background: Union[Literal[False], None] = None,
- envs: Optional[Dict[str, str]] = None,
- user: Username = "user",
- cwd: Optional[str] = None,
- on_stdout: Optional[OutputHandler[Stdout]] = None,
- on_stderr: Optional[OutputHandler[Stderr]] = None,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None) -> CommandResult
+async def kill(request_timeout: Optional[float] = None) -> bool
```
-Start a new command and wait until it finishes executing.
+Kill the sandbox.
**Arguments**:
-- `cmd`: Command to execute
-- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background
-- `envs`: Environment variables used for the command
-- `user`: User to run the command as
-- `cwd`: Working directory to run the command
-- `on_stdout`: Callback for command stdout output
-- `on_stderr`: Callback for command stderr output
-- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`CommandResult` result of the command execution
+`True` if the sandbox was killed, `False` if the sandbox was not found
-#### run
+#### kill
```python
@overload
-async def run(cmd: str,
- background: Literal[True],
- envs: Optional[Dict[str, str]] = None,
- user: Username = "user",
- cwd: Optional[str] = None,
- on_stdout: Optional[OutputHandler[Stdout]] = None,
- on_stderr: Optional[OutputHandler[Stderr]] = None,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None) -> AsyncCommandHandle
+@staticmethod
+async def kill(sandbox_id: str,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ request_timeout: Optional[float] = None) -> bool
```
-Start a new command and return a handle to interact with it.
+Kill the sandbox specified by sandbox ID.
**Arguments**:
-- `cmd`: Command to execute
-- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background**
-- `envs`: Environment variables used for the command
-- `user`: User to run the command as
-- `cwd`: Working directory to run the command
-- `on_stdout`: Callback for command stdout output
-- `on_stderr`: Callback for command stderr output
-- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+- `sandbox_id`: Sandbox ID
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`AsyncCommandHandle` handle to interact with the running command
+`True` if the sandbox was killed, `False` if the sandbox was not found
-#### connect
+#### set\_timeout
```python
-async def connect(
- pid: int,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None,
- on_stdout: Optional[OutputHandler[Stdout]] = None,
- on_stderr: Optional[OutputHandler[Stderr]] = None
-) -> AsyncCommandHandle
+@overload
+async def set_timeout(timeout: int,
+ request_timeout: Optional[float] = None) -> None
```
-Connects to a running command.
+Set the timeout of the sandbox.
-You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results.
+After the timeout expires the sandbox will be automatically killed.
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
+
+Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
**Arguments**:
-- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()`
-- `request_timeout`: Request timeout in **seconds**
-- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
-- `on_stdout`: Callback for command stdout output
-- `on_stderr`: Callback for command stderr output
+- `timeout`: Timeout for the sandbox in **seconds**
+- `request_timeout`: Timeout for the request in **seconds**
+
+
+#### set\_timeout
+
+```python
+@overload
+@staticmethod
+async def set_timeout(sandbox_id: str,
+ timeout: int,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ request_timeout: Optional[float] = None) -> None
+```
+
+Set the timeout of the specified sandbox.
+
+After the timeout expires the sandbox will be automatically killed.
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
-**Returns**:
+Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
-`AsyncCommandHandle` handle to interact with the running command
+**Arguments**:
+
+- `sandbox_id`: Sandbox ID
+- `timeout`: Timeout for the sandbox in **seconds**
+- `request_timeout`: Timeout for the request in **seconds**
-## Pty
+## Filesystem
```python
-class Pty()
+class Filesystem()
```
-Module for interacting with PTYs (pseudo-terminals) in the sandbox.
+Module for interacting with the filesystem in the sandbox.
-#### kill
+#### read
```python
-async def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+@overload
+async def read(path: str,
+ format: Literal["text"] = "text",
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> str
```
-Kill PTY.
+Read file content as a `str`.
**Arguments**:
-- `pid`: Process ID of the PTY
+- `path`: Path to the file
+- `user`: Run the operation as this user
+- `format`: Format of the file content—`text` by default
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`true` if the PTY was killed, `false` if the PTY was not found
+File content as a `str`
-#### send\_stdin
+#### read
```python
-async def send_stdin(pid: int,
- data: bytes,
- request_timeout: Optional[float] = None) -> None
+@overload
+async def read(path: str,
+ format: Literal["bytes"],
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bytearray
```
-Send input to a PTY.
+Read file content as a `bytearray`.
**Arguments**:
-- `pid`: Process ID of the PTY
-- `data`: Input data to send
+- `path`: Path to the file
+- `user`: Run the operation as this user
+- `format`: Format of the file content—`bytes`
- `request_timeout`: Timeout for the request in **seconds**
+**Returns**:
+
+File content as a `bytearray`
-#### create
+
+#### read
```python
-async def create(
- size: PtySize,
- on_data: OutputHandler[PtyOutput],
+@overload
+async def read(
+ path: str,
+ format: Literal["stream"],
user: Username = "user",
- cwd: Optional[str] = None,
- envs: Optional[Dict[str, str]] = None,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None) -> AsyncCommandHandle
+ request_timeout: Optional[float] = None) -> AsyncIterator[bytes]
```
-Start a new PTY (pseudo-terminal).
+Read file content as a `AsyncIterator[bytes]`.
**Arguments**:
-- `size`: Size of the PTY
-- `on_data`: Callback to handle PTY data
-- `user`: User to use for the PTY
-- `cwd`: Working directory for the PTY
-- `envs`: Environment variables for the PTY
-- `timeout`: Timeout for the PTY in **seconds**
+- `path`: Path to the file
+- `user`: Run the operation as this user
+- `format`: Format of the file content—`stream`
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-Handle to interact with the PTY
+File content as an `AsyncIterator[bytes]`
-#### resize
+#### write
```python
-async def resize(pid: int,
- size: PtySize,
- request_timeout: Optional[float] = None)
+async def write(path: str,
+ data: Union[str, bytes, IO],
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
```
-Resize PTY.
+Write content to a file on the path.
-Call this when the terminal window is resized and the number of columns and rows has changed.
+Writing to a file that doesn't exist creates the file.
+
+Writing to a file that already exists overwrites the file.
+
+Writing to a file at path that doesn't exist creates the necessary directories.
**Arguments**:
-- `pid`: Process ID of the PTY
-- `size`: New size of the PTY
+- `path`: Path to the file
+- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`.
+- `user`: Run the operation as this user
- `request_timeout`: Timeout for the request in **seconds**
+**Returns**:
+Information about the written file
-## AsyncCommandHandle
+#### list
```python
-class AsyncCommandHandle()
+async def list(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> List[EntryInfo]
```
-Command execution handle.
-
-It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.
+List entries in a directory.
+**Arguments**:
-#### pid
+- `path`: Path to the directory
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
-```python
-@property
-def pid()
-```
+**Returns**:
-Command process ID.
+List of entries in the directory
-#### stdout
+#### exists
```python
-@property
-def stdout()
+async def exists(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bool
```
-Command stdout output.
+Check if a file or a directory exists.
+**Arguments**:
-#### stderr
+- `path`: Path to a file or a directory
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
-```python
-@property
-def stderr()
-```
+**Returns**:
-Command stderr output.
+`True` if the file or directory exists, `False` otherwise
-#### error
+#### remove
```python
-@property
-def error()
+async def remove(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> None
```
-Command execution error message.
-
+Remove a file or a directory.
-#### exit\_code
+**Arguments**:
-```python
-@property
-def exit_code()
-```
+- `path`: Path to a file or a directory
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
-Command execution exit code.
-`0` if the command finished successfully.
+#### rename
-It is `None` if the command is still running.
+```python
+async def rename(old_path: str,
+ new_path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
+```
+Rename a file or directory.
-#### disconnect
+**Arguments**:
-```python
-async def disconnect() -> None
-```
+- `old_path`: Path to the file or directory to rename
+- `new_path`: New path to the file or directory
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
-Disconnects from the command.
+**Returns**:
-The command is not killed, but SDK stops receiving events from the command.
-You can reconnect to the command using `sandbox.commands.connect` method.
+Information about the renamed file or directory
-#### wait
+#### make\_dir
```python
-async def wait() -> CommandResult
+async def make_dir(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bool
```
-Wait for the command to finish and return the result.
+Create a new directory and all directories along the way if needed on the specified path.
-If the command exits with a non-zero exit code, it throws a `CommandExitException`.
+**Arguments**:
+
+- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'.
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`CommandResult` result of command execution
+`True` if the directory was created, `False` if the directory already exists
-#### kill
+#### watch\_dir
```python
-async def kill() -> bool
+async def watch_dir(path: str,
+ on_event: OutputHandler[FilesystemEvent],
+ on_exit: Optional[OutputHandler[Exception]] = None,
+ user: Username = "user",
+ request_timeout: Optional[float] = None,
+ timeout: Optional[float] = 60) -> AsyncWatchHandle
```
-Kills the command.
+Watch directory for filesystem events.
-It uses `SIGKILL` signal to kill the command
+**Arguments**:
+
+- `path`: Path to a directory to watch
+- `on_event`: Callback to call on each event in the directory
+- `on_exit`: Callback to call when the watching ends
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
+- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time
**Returns**:
-`True` if the command was killed successfully, `False` if the command was not found
+`AsyncWatchHandle` object for stopping watching directory
-## SandboxApi
+## AsyncWatchHandle
```python
-class SandboxApi(SandboxApiBase)
+class AsyncWatchHandle()
```
+Handle for watching a directory in the sandbox filesystem.
-#### list
-
-```python
-@classmethod
-async def list(cls,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- request_timeout: Optional[float] = None) -> List[SandboxInfo]
-```
-
-List all running sandboxes.
+Use `.stop()` to stop watching the directory.
-**Arguments**:
-- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable
-- `request_timeout`: Timeout for the request in **seconds**
+#### stop
-**Returns**:
+```python
+async def stop()
+```
-List of running sandboxes
+Stop watching the directory.
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx
index ee88ace74..1e39bf353 100644
--- a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx
+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx
@@ -1,901 +1,901 @@
-## Sandbox
+## Commands
```python
-class Sandbox(SandboxSetup, SandboxApi)
+class Commands()
```
-E2B cloud sandbox is a secure and isolated cloud environment.
-
-The sandbox allows you to:
-- Access Linux OS
-- Create, list, and delete files and directories
-- Run commands
-- Run isolated code
-- Access the internet
-
-Check docs [here](https://e2b.dev/docs).
+Module for executing commands in the sandbox.
-Use the `Sandbox()` to create a new sandbox.
-**Example**:
+#### list
```python
-from e2b import Sandbox
-
-sandbox = Sandbox()
+def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]
```
+Lists all running commands and PTY sessions.
-#### files
+**Arguments**:
-```python
-@property
-def files() -> Filesystem
-```
+- `request_timeout`: Timeout for the request in **seconds**
-Module for interacting with the sandbox filesystem.
+**Returns**:
+List of running commands and PTY sessions
-#### commands
+
+#### kill
```python
-@property
-def commands() -> Commands
+def kill(pid: int, request_timeout: Optional[float] = None) -> bool
```
-Module for running commands in the sandbox.
+Kills a running command specified by its process ID.
+It uses `SIGKILL` signal to kill the command.
-#### pty
+**Arguments**:
-```python
-@property
-def pty() -> Pty
-```
+- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()`
+- `request_timeout`: Timeout for the request in **seconds**
-Module for interacting with the sandbox pseudo-terminal.
+**Returns**:
+`True` if the command was killed, `False` if the command was not found
-#### sandbox\_id
+
+#### send\_stdin
```python
-@property
-def sandbox_id() -> str
+def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None)
```
-Unique identifier of the sandbox
+Send data to command stdin.
+
+:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`.
+:param data: Data to send to the command
+:param request_timeout: Timeout for the request in **seconds**
-#### \_\_init\_\_
+
+#### run
```python
-def __init__(template: Optional[str] = None,
- timeout: Optional[int] = None,
- metadata: Optional[Dict[str, str]] = None,
- envs: Optional[Dict[str, str]] = None,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- sandbox_id: Optional[str] = None,
- request_timeout: Optional[float] = None)
+@overload
+def run(cmd: str,
+ background: Union[Literal[False], None] = None,
+ envs: Optional[Dict[str, str]] = None,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ on_stdout: Optional[Callable[[str], None]] = None,
+ on_stderr: Optional[Callable[[str], None]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> CommandResult
```
-Create a new sandbox.
-
-By default, the sandbox is created from the default `base` sandbox template.
+Start a new command and wait until it finishes executing.
**Arguments**:
-- `template`: Sandbox template name or ID
-- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users
-- `metadata`: Custom metadata for the sandbox
-- `envs`: Custom environment variables for the sandbox
-- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+- `cmd`: Command to execute
+- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background
+- `envs`: Environment variables used for the command
+- `user`: User to run the command as
+- `cwd`: Working directory to run the command
+- `on_stdout`: Callback for command stdout output
+- `on_stderr`: Callback for command stderr output
+- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-sandbox instance for the new sandbox
+`CommandResult` result of the command execution
-#### is\_running
+#### run
```python
-def is_running(request_timeout: Optional[float] = None) -> bool
+@overload
+def run(cmd: str,
+ background: Literal[True],
+ envs: Optional[Dict[str, str]] = None,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ on_stdout: None = None,
+ on_stderr: None = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> CommandHandle
```
-Check if the sandbox is running.
+Start a new command and return a handle to interact with it.
**Arguments**:
+- `cmd`: Command to execute
+- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background**
+- `envs`: Environment variables used for the command
+- `user`: User to run the command as
+- `cwd`: Working directory to run the command
+- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`True` if the sandbox is running, `False` otherwise
-Example
-```python
-sandbox = Sandbox()
-sandbox.is_running() # Returns True
-
-sandbox.kill()
-sandbox.is_running() # Returns False
-```
+`CommandHandle` handle to interact with the running command
#### connect
```python
-@classmethod
-def connect(cls,
- sandbox_id: str,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None)
+def connect(pid: int,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None)
```
-Connects to an existing Sandbox.
+Connects to a running command.
-With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
+You can use `CommandHandle.wait()` to wait for the command to finish and get execution results.
**Arguments**:
-- `sandbox_id`: Sandbox ID
-- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()`
+- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time
+- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-sandbox instance for the existing sandbox
-@example
-```python
-sandbox = Sandbox()
-sandbox_id = sandbox.sandbox_id
+`CommandHandle` handle to interact with the running command
-same_sandbox = Sandbox.connect(sandbox_id)
-#### kill
+
+## CommandHandle
```python
-@overload
-def kill(request_timeout: Optional[float] = None) -> bool
+class CommandHandle()
```
-Kill the sandbox.
+Command execution handle.
-**Arguments**:
+It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.
-- `request_timeout`: Timeout for the request in **seconds**
-**Returns**:
+#### pid
-`True` if the sandbox was killed, `False` if the sandbox was not found
+```python
+@property
+def pid()
+```
+Command process ID.
-#### kill
+
+#### \_\_iter\_\_
```python
-@overload
-@staticmethod
-def kill(sandbox_id: str,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- request_timeout: Optional[float] = None) -> bool
+def __iter__()
```
-Kill the sandbox specified by sandbox ID.
+Iterate over the command output.
-**Arguments**:
+**Returns**:
-- `sandbox_id`: Sandbox ID
-- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
-- `request_timeout`: Timeout for the request in **seconds**
+Generator of command outputs
-**Returns**:
-`True` if the sandbox was killed, `False` if the sandbox was not found
+#### disconnect
+```python
+def disconnect() -> None
+```
-#### kill
+Disconnect from the command.
+
+The command is not killed, but SDK stops receiving events from the command.
+You can reconnect to the command using `sandbox.commands.connect` method.
+
+
+#### wait
```python
-@class_method_variant("_cls_kill")
-def kill(request_timeout: Optional[float] = None) -> bool
+def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None,
+ on_stdout: Optional[Callable[[str], None]] = None,
+ on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult
```
-Kill the sandbox.
+Wait for the command to finish and returns the result.
+
+If the command exits with a non-zero exit code, it throws a `CommandExitException`.
**Arguments**:
-- `request_timeout`: Timeout for the request
+- `on_pty`: Callback for pty output
+- `on_stdout`: Callback for stdout output
+- `on_stderr`: Callback for stderr output
**Returns**:
-`True` if the sandbox was killed, `False` if the sandbox was not found
+`CommandResult` result of command execution
-#### set\_timeout
+#### kill
```python
-@overload
-def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None
+def kill() -> bool
```
-Set the timeout of the sandbox.
+Kills the command.
-After the timeout expires the sandbox will be automatically killed.
-This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
+It uses `SIGKILL` signal to kill the command.
-Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
+**Returns**:
-**Arguments**:
+Whether the command was killed successfully
-- `timeout`: Timeout for the sandbox in **seconds**
-- `request_timeout`: Timeout for the request in **seconds**
-#### set\_timeout
+
+## Pty
```python
-@overload
-@staticmethod
-def set_timeout(sandbox_id: str,
- timeout: int,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- request_timeout: Optional[float] = None) -> None
+class Pty()
```
-Set the timeout of the sandbox specified by sandbox ID.
+Module for interacting with PTYs (pseudo-terminals) in the sandbox.
-After the timeout expires the sandbox will be automatically killed.
-This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
-Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
+#### kill
+
+```python
+def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+```
+
+Kill PTY.
**Arguments**:
-- `sandbox_id`: Sandbox ID
-- `timeout`: Timeout for the sandbox in **seconds**
-- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+- `pid`: Process ID of the PTY
- `request_timeout`: Timeout for the request in **seconds**
+**Returns**:
+`true` if the PTY was killed, `false` if the PTY was not found
-## Filesystem
+#### send\_stdin
```python
-class Filesystem()
+def send_stdin(pid: int,
+ data: bytes,
+ request_timeout: Optional[float] = None) -> None
```
-Module for interacting with the filesystem in the sandbox.
+Send input to a PTY.
+
+**Arguments**:
+
+- `pid`: Process ID of the PTY
+- `data`: Input data to send
+- `request_timeout`: Timeout for the request in **seconds**
-#### read
+#### create
```python
-@overload
-def read(path: str,
- format: Literal["text"] = "text",
- user: Username = "user",
- request_timeout: Optional[float] = None) -> str
+def create(size: PtySize,
+ user: Username = "user",
+ cwd: Optional[str] = None,
+ envs: Optional[Dict[str, str]] = None,
+ timeout: Optional[float] = 60,
+ request_timeout: Optional[float] = None) -> CommandHandle
```
-Read file content as a `str`.
+Start a new PTY (pseudo-terminal).
**Arguments**:
-- `path`: Path to the file
-- `user`: Run the operation as this user
-- `format`: Format of the file content—`text` by default
+- `size`: Size of the PTY
+- `user`: User to use for the PTY
+- `cwd`: Working directory for the PTY
+- `envs`: Environment variables for the PTY
+- `timeout`: Timeout for the PTY in **seconds**
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-File content as a `str`
+Handle to interact with the PTY
-#### read
+#### resize
```python
-@overload
-def read(path: str,
- format: Literal["bytes"],
- user: Username = "user",
- request_timeout: Optional[float] = None) -> bytearray
+def resize(pid: int,
+ size: PtySize,
+ request_timeout: Optional[float] = None) -> None
```
-Read file content as a `bytearray`.
+Resize PTY.
+
+Call this when the terminal window is resized and the number of columns and rows has changed.
**Arguments**:
-- `path`: Path to the file
-- `user`: Run the operation as this user
-- `format`: Format of the file content—`bytes`
-- `request_timeout`: Timeout for the request in **seconds**
+- `pid`: Process ID of the PTY
+- `size`: New size of the PTY
+- `request_timeout`: Timeout for the request in **seconds**s
-**Returns**:
-File content as a `bytearray`
-#### read
+## SandboxApi
```python
-@overload
-def read(path: str,
- format: Literal["stream"],
- user: Username = "user",
- request_timeout: Optional[float] = None) -> Iterator[bytes]
+class SandboxApi(SandboxApiBase)
```
-Read file content as a `Iterator[bytes]`.
+
+#### list
+
+```python
+@classmethod
+def list(cls,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ request_timeout: Optional[float] = None) -> List[SandboxInfo]
+```
+
+List all running sandboxes.
**Arguments**:
-- `path`: Path to the file
-- `user`: Run the operation as this user
-- `format`: Format of the file content—`stream`
+- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-File content as an `Iterator[bytes]`
+List of sandbox info
+
-#### write
+
+## Sandbox
```python
-def write(path: str,
- data: Union[str, bytes, IO],
- user: Username = "user",
- request_timeout: Optional[float] = None) -> EntryInfo
+class Sandbox(SandboxSetup, SandboxApi)
```
-Write content to a file on the path.
-
-Writing to a file that doesn't exist creates the file.
+E2B cloud sandbox is a secure and isolated cloud environment.
-Writing to a file that already exists overwrites the file.
+The sandbox allows you to:
+- Access Linux OS
+- Create, list, and delete files and directories
+- Run commands
+- Run isolated code
+- Access the internet
-Writing to a file at path that doesn't exist creates the necessary directories.
+Check docs [here](https://e2b.dev/docs).
-**Arguments**:
+Use the `Sandbox()` to create a new sandbox.
-- `path`: Path to the file
-- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`.
-- `user`: Run the operation as this user
-- `request_timeout`: Timeout for the request in **seconds**
+**Example**:
-**Returns**:
+```python
+from e2b import Sandbox
-Information about the written file
+sandbox = Sandbox()
+```
-#### list
+#### files
```python
-def list(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> List[EntryInfo]
+@property
+def files() -> Filesystem
```
-List entries in a directory.
+Module for interacting with the sandbox filesystem.
-**Arguments**:
-- `path`: Path to the directory
-- `user`: Run the operation as this user
-- `request_timeout`: Timeout for the request in **seconds**
+#### commands
-**Returns**:
+```python
+@property
+def commands() -> Commands
+```
-List of entries in the directory
+Module for running commands in the sandbox.
-#### exists
+#### pty
```python
-def exists(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> bool
+@property
+def pty() -> Pty
```
-Check if a file or a directory exists.
+Module for interacting with the sandbox pseudo-terminal.
-**Arguments**:
-- `path`: Path to a file or a directory
-- `user`: Run the operation as this user
-- `request_timeout`: Timeout for the request in **seconds**
+#### sandbox\_id
-**Returns**:
+```python
+@property
+def sandbox_id() -> str
+```
-`True` if the file or directory exists, `False` otherwise
+Unique identifier of the sandbox
-#### remove
+#### \_\_init\_\_
```python
-def remove(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> None
+def __init__(template: Optional[str] = None,
+ timeout: Optional[int] = None,
+ metadata: Optional[Dict[str, str]] = None,
+ envs: Optional[Dict[str, str]] = None,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ sandbox_id: Optional[str] = None,
+ request_timeout: Optional[float] = None)
```
-Remove a file or a directory.
+Create a new sandbox.
+
+By default, the sandbox is created from the default `base` sandbox template.
**Arguments**:
-- `path`: Path to a file or a directory
-- `user`: Run the operation as this user
+- `template`: Sandbox template name or ID
+- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users
+- `metadata`: Custom metadata for the sandbox
+- `envs`: Custom environment variables for the sandbox
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
- `request_timeout`: Timeout for the request in **seconds**
+**Returns**:
-#### rename
+sandbox instance for the new sandbox
+
+
+#### is\_running
```python
-def rename(old_path: str,
- new_path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> EntryInfo
+def is_running(request_timeout: Optional[float] = None) -> bool
```
-Rename a file or directory.
+Check if the sandbox is running.
**Arguments**:
-- `old_path`: Path to the file or directory to rename
-- `new_path`: New path to the file or directory
-- `user`: Run the operation as this user
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-Information about the renamed file or directory
+`True` if the sandbox is running, `False` otherwise
+Example
+```python
+sandbox = Sandbox()
+sandbox.is_running() # Returns True
+
+sandbox.kill()
+sandbox.is_running() # Returns False
+```
-#### make\_dir
+#### connect
```python
-def make_dir(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> bool
+@classmethod
+def connect(cls,
+ sandbox_id: str,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None)
```
-Create a new directory and all directories along the way if needed on the specified path.
+Connects to an existing Sandbox.
+
+With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
**Arguments**:
-- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'.
-- `user`: Run the operation as this user
-- `request_timeout`: Timeout for the request in **seconds**
+- `sandbox_id`: Sandbox ID
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
**Returns**:
-`True` if the directory was created, `False` if the directory already exists
+sandbox instance for the existing sandbox
+@example
+```python
+sandbox = Sandbox()
+sandbox_id = sandbox.sandbox_id
+
+same_sandbox = Sandbox.connect(sandbox_id)
-#### watch\_dir
+#### kill
```python
-def watch_dir(path: str,
- user: Username = "user",
- request_timeout: Optional[float] = None) -> WatchHandle
+@overload
+def kill(request_timeout: Optional[float] = None) -> bool
```
-Watch directory for filesystem events.
+Kill the sandbox.
**Arguments**:
-- `path`: Path to a directory to watch
-- `user`: Run the operation as this user
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`WatchHandle` object for stopping watching directory
-
-
+`True` if the sandbox was killed, `False` if the sandbox was not found
-## WatchHandle
+#### kill
```python
-class WatchHandle()
+@overload
+@staticmethod
+def kill(sandbox_id: str,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ request_timeout: Optional[float] = None) -> bool
```
-Handle for watching filesystem events.
-It is used to get the latest events that have occurred in the watched directory.
-
-Use `.stop()` to stop watching the directory.
+Kill the sandbox specified by sandbox ID.
+**Arguments**:
-#### stop
+- `sandbox_id`: Sandbox ID
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
+- `request_timeout`: Timeout for the request in **seconds**
-```python
-def stop()
-```
+**Returns**:
-Stop watching the directory.
-After you stop the watcher you won't be able to get the events anymore.
+`True` if the sandbox was killed, `False` if the sandbox was not found
-#### get\_new\_events
+#### kill
```python
-def get_new_events() -> List[FilesystemEvent]
+@class_method_variant("_cls_kill")
+def kill(request_timeout: Optional[float] = None) -> bool
```
-Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now.
+Kill the sandbox.
-**Returns**:
+**Arguments**:
-List of filesystem events
+- `request_timeout`: Timeout for the request
+**Returns**:
+`True` if the sandbox was killed, `False` if the sandbox was not found
-## Commands
+#### set\_timeout
```python
-class Commands()
+@overload
+def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None
```
-Module for executing commands in the sandbox.
-
-
-#### list
+Set the timeout of the sandbox.
-```python
-def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]
-```
+After the timeout expires the sandbox will be automatically killed.
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
-Lists all running commands and PTY sessions.
+Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
**Arguments**:
+- `timeout`: Timeout for the sandbox in **seconds**
- `request_timeout`: Timeout for the request in **seconds**
-**Returns**:
-
-List of running commands and PTY sessions
-
-#### kill
+#### set\_timeout
```python
-def kill(pid: int, request_timeout: Optional[float] = None) -> bool
+@overload
+@staticmethod
+def set_timeout(sandbox_id: str,
+ timeout: int,
+ api_key: Optional[str] = None,
+ domain: Optional[str] = None,
+ debug: Optional[bool] = None,
+ request_timeout: Optional[float] = None) -> None
```
-Kills a running command specified by its process ID.
+Set the timeout of the sandbox specified by sandbox ID.
-It uses `SIGKILL` signal to kill the command.
+After the timeout expires the sandbox will be automatically killed.
+This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`.
+
+Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users.
**Arguments**:
-- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()`
+- `sandbox_id`: Sandbox ID
+- `timeout`: Timeout for the sandbox in **seconds**
+- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
- `request_timeout`: Timeout for the request in **seconds**
-**Returns**:
-`True` if the command was killed, `False` if the command was not found
-#### send\_stdin
+## Filesystem
```python
-def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None)
+class Filesystem()
```
-Send data to command stdin.
-
-:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`.
-:param data: Data to send to the command
-:param request_timeout: Timeout for the request in **seconds**
-
+Module for interacting with the filesystem in the sandbox.
-#### run
+#### read
```python
@overload
-def run(cmd: str,
- background: Union[Literal[False], None] = None,
- envs: Optional[Dict[str, str]] = None,
- user: Username = "user",
- cwd: Optional[str] = None,
- on_stdout: Optional[Callable[[str], None]] = None,
- on_stderr: Optional[Callable[[str], None]] = None,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None) -> CommandResult
+def read(path: str,
+ format: Literal["text"] = "text",
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> str
```
-Start a new command and wait until it finishes executing.
+Read file content as a `str`.
**Arguments**:
-- `cmd`: Command to execute
-- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background
-- `envs`: Environment variables used for the command
-- `user`: User to run the command as
-- `cwd`: Working directory to run the command
-- `on_stdout`: Callback for command stdout output
-- `on_stderr`: Callback for command stderr output
-- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+- `path`: Path to the file
+- `user`: Run the operation as this user
+- `format`: Format of the file content—`text` by default
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`CommandResult` result of the command execution
+File content as a `str`
-#### run
+#### read
```python
@overload
-def run(cmd: str,
- background: Literal[True],
- envs: Optional[Dict[str, str]] = None,
- user: Username = "user",
- cwd: Optional[str] = None,
- on_stdout: None = None,
- on_stderr: None = None,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None) -> CommandHandle
+def read(path: str,
+ format: Literal["bytes"],
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bytearray
```
-Start a new command and return a handle to interact with it.
+Read file content as a `bytearray`.
**Arguments**:
-- `cmd`: Command to execute
-- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background**
-- `envs`: Environment variables used for the command
-- `user`: User to run the command as
-- `cwd`: Working directory to run the command
-- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time
+- `path`: Path to the file
+- `user`: Run the operation as this user
+- `format`: Format of the file content—`bytes`
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`CommandHandle` handle to interact with the running command
+File content as a `bytearray`
-#### connect
+#### read
```python
-def connect(pid: int,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None)
+@overload
+def read(path: str,
+ format: Literal["stream"],
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> Iterator[bytes]
```
-Connects to a running command.
-
-You can use `CommandHandle.wait()` to wait for the command to finish and get execution results.
+Read file content as a `Iterator[bytes]`.
**Arguments**:
-- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()`
-- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time
+- `path`: Path to the file
+- `user`: Run the operation as this user
+- `format`: Format of the file content—`stream`
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`CommandHandle` handle to interact with the running command
-
-
+File content as an `Iterator[bytes]`
-## Pty
+#### write
```python
-class Pty()
+def write(path: str,
+ data: Union[str, bytes, IO],
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
```
-Module for interacting with PTYs (pseudo-terminals) in the sandbox.
-
+Write content to a file on the path.
-#### kill
+Writing to a file that doesn't exist creates the file.
-```python
-def kill(pid: int, request_timeout: Optional[float] = None) -> bool
-```
+Writing to a file that already exists overwrites the file.
-Kill PTY.
+Writing to a file at path that doesn't exist creates the necessary directories.
**Arguments**:
-- `pid`: Process ID of the PTY
+- `path`: Path to the file
+- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`.
+- `user`: Run the operation as this user
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`true` if the PTY was killed, `false` if the PTY was not found
+Information about the written file
-#### send\_stdin
+#### list
```python
-def send_stdin(pid: int,
- data: bytes,
- request_timeout: Optional[float] = None) -> None
+def list(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> List[EntryInfo]
```
-Send input to a PTY.
+List entries in a directory.
**Arguments**:
-- `pid`: Process ID of the PTY
-- `data`: Input data to send
+- `path`: Path to the directory
+- `user`: Run the operation as this user
- `request_timeout`: Timeout for the request in **seconds**
+**Returns**:
-#### create
+List of entries in the directory
+
+
+#### exists
```python
-def create(size: PtySize,
+def exists(path: str,
user: Username = "user",
- cwd: Optional[str] = None,
- envs: Optional[Dict[str, str]] = None,
- timeout: Optional[float] = 60,
- request_timeout: Optional[float] = None) -> CommandHandle
+ request_timeout: Optional[float] = None) -> bool
```
-Start a new PTY (pseudo-terminal).
+Check if a file or a directory exists.
**Arguments**:
-- `size`: Size of the PTY
-- `user`: User to use for the PTY
-- `cwd`: Working directory for the PTY
-- `envs`: Environment variables for the PTY
-- `timeout`: Timeout for the PTY in **seconds**
+- `path`: Path to a file or a directory
+- `user`: Run the operation as this user
- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-Handle to interact with the PTY
+`True` if the file or directory exists, `False` otherwise
-#### resize
+#### remove
```python
-def resize(pid: int,
- size: PtySize,
+def remove(path: str,
+ user: Username = "user",
request_timeout: Optional[float] = None) -> None
```
-Resize PTY.
-
-Call this when the terminal window is resized and the number of columns and rows has changed.
+Remove a file or a directory.
**Arguments**:
-- `pid`: Process ID of the PTY
-- `size`: New size of the PTY
-- `request_timeout`: Timeout for the request in **seconds**s
-
-
+- `path`: Path to a file or a directory
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
-## CommandHandle
+#### rename
```python
-class CommandHandle()
+def rename(old_path: str,
+ new_path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> EntryInfo
```
-Command execution handle.
-
-It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.
+Rename a file or directory.
+**Arguments**:
-#### pid
+- `old_path`: Path to the file or directory to rename
+- `new_path`: New path to the file or directory
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
-```python
-@property
-def pid()
-```
+**Returns**:
-Command process ID.
+Information about the renamed file or directory
-#### \_\_iter\_\_
+#### make\_dir
```python
-def __iter__()
+def make_dir(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> bool
```
-Iterate over the command output.
-
-**Returns**:
-
-Generator of command outputs
-
+Create a new directory and all directories along the way if needed on the specified path.
-#### disconnect
+**Arguments**:
-```python
-def disconnect() -> None
-```
+- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'.
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
-Disconnect from the command.
+**Returns**:
-The command is not killed, but SDK stops receiving events from the command.
-You can reconnect to the command using `sandbox.commands.connect` method.
+`True` if the directory was created, `False` if the directory already exists
-#### wait
+#### watch\_dir
```python
-def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None,
- on_stdout: Optional[Callable[[str], None]] = None,
- on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult
+def watch_dir(path: str,
+ user: Username = "user",
+ request_timeout: Optional[float] = None) -> WatchHandle
```
-Wait for the command to finish and returns the result.
-
-If the command exits with a non-zero exit code, it throws a `CommandExitException`.
+Watch directory for filesystem events.
**Arguments**:
-- `on_pty`: Callback for pty output
-- `on_stdout`: Callback for stdout output
-- `on_stderr`: Callback for stderr output
+- `path`: Path to a directory to watch
+- `user`: Run the operation as this user
+- `request_timeout`: Timeout for the request in **seconds**
**Returns**:
-`CommandResult` result of command execution
-
-
-#### kill
+`WatchHandle` object for stopping watching directory
-```python
-def kill() -> bool
-```
-Kills the command.
-It uses `SIGKILL` signal to kill the command.
-**Returns**:
+## WatchHandle
-Whether the command was killed successfully
+```python
+class WatchHandle()
+```
+Handle for watching filesystem events.
+It is used to get the latest events that have occurred in the watched directory.
+Use `.stop()` to stop watching the directory.
-## SandboxApi
+#### stop
```python
-class SandboxApi(SandboxApiBase)
+def stop()
```
+Stop watching the directory.
+After you stop the watcher you won't be able to get the events anymore.
+
-#### list
+#### get\_new\_events
```python
-@classmethod
-def list(cls,
- api_key: Optional[str] = None,
- domain: Optional[str] = None,
- debug: Optional[bool] = None,
- request_timeout: Optional[float] = None) -> List[SandboxInfo]
+def get_new_events() -> List[FilesystemEvent]
```
-List all running sandboxes.
-
-**Arguments**:
-
-- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable
-- `request_timeout`: Timeout for the request in **seconds**
+Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now.
**Returns**:
-List of sandbox info
+List of filesystem events
diff --git a/packages/js-sdk/package.json b/packages/js-sdk/package.json
index 8f788ec7e..cbf586f7d 100644
--- a/packages/js-sdk/package.json
+++ b/packages/js-sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "e2b",
- "version": "1.0.3",
+ "version": "1.0.4",
"description": "E2B SDK that give agents cloud environments",
"homepage": "https://e2b.dev",
"license": "MIT",