Open-source, secure environment with real-world tools for enterprise-grade agents.
Python agentaiai-agentai-agentscode-interpretercopilotdevelopmentdevtoolsgptgpt-4javascriptllmnextjsopenaipythonreactsoftwaretypescript
[skip ci] Release new versions
github-actions[bot]21b1374a6e87
diff --git a/.changeset/long-trains-fold.md b/.changeset/long-trains-fold.mddeleted file mode 100644index fdf182f6c..000000000--- a/.changeset/long-trains-fold.md+++ /dev/null@@ -1,5 +0,0 @@-----'@e2b/cli': major------Release new CLI versiondiff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/auth/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/auth/page.mdxnew file mode 100644index 000000000..5e547262c--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/auth/page.mdx@@ -0,0 +1,58 @@+# e2b auth+++authentication commands++## Usage++```bash+e2b auth [options] [command]+```+# e2b auth login+++log in to CLI++## Usage++```bash+e2b auth login [options]+```+++# e2b auth logout+++log out of CLI++## Usage++```bash+e2b auth logout [options]+```+++# e2b auth info+++get information about the current user++## Usage++```bash+e2b auth info [options]+```+++# e2b auth configure+++configure user++## Usage++```bash+e2b auth configure [options]+```++diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/sandbox/page.mdxnew file mode 100644index 000000000..fc8e99343--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/sandbox/page.mdx@@ -0,0 +1,89 @@+# e2b sandbox+++work with sandboxes++## Usage++```bash+e2b sandbox [options] [command]+```+# e2b sandbox connect+++connect terminal to already running sandbox++## Usage++```bash+e2b sandbox connect [options] <sandboxID>+```+++# e2b sandbox list+++list all running sandboxes++## Usage++```bash+e2b sandbox list [options]+```+++# e2b sandbox kill+++kill sandbox++## Usage++```bash+e2b sandbox kill [options] [sandboxID]+```++## Options+++ - `-a, --all: kill all running sandboxes `+++# e2b sandbox spawn+++spawn sandbox and connect terminal to it++## Usage++```bash+e2b sandbox spawn [options] [template]+```++## Options+++ - `-p, --path <path>: change root directory where command is executed to <path> directory `+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `+++# e2b sandbox logs+++show logs for sandbox++## Usage++```bash+e2b sandbox logs [options] <sandboxID>+```++## Options+++ - `--level <level>: filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]`+ - `-f, --follow: keep streaming logs until the sandbox is closed `+ - `--format <format>: specify format for printing logs (json, pretty) [default: pretty]`+ - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. `++diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/template/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/template/page.mdxnew file mode 100644index 000000000..48d3dcb2e--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/template/page.mdx@@ -0,0 +1,90 @@+# e2b template+++manage sandbox templates++## Usage++```bash+e2b template [options] [command]+```+# e2b template build+++build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config.++## Usage++```bash+e2b template build [options] [template]+```++## Options+++ - `-p, --path <path>: change root directory where command is executed to <path> directory `+ - `-d, --dockerfile <file>: specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. `+ - `-n, --name <template-name>: specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. `+ - `-c, --cmd <start-command>: specify command that will be executed when the sandbox is started. `+ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `+ - `--cpu-count <cpu-count>: specify the number of CPUs that will be used to run the sandbox. The default value is 2. `+ - `--memory-mb <memory-mb>: specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. `+ - `--build-arg <args...>: specify additional build arguments for the build command. The format should be <varname>=<value>. `+++# e2b template list+++list sandbox templates++## Usage++```bash+e2b template list [options]+```++## Options+++ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `+++# e2b template init+++create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile++## Usage++```bash+e2b template init [options]+```++## Options+++ - `-p, --path <path>: change root directory where command is executed to <path> directory `+++# e2b template delete+++delete sandbox template and e2b.toml config++## Usage++```bash+e2b template delete [options] [template]+```++## Options+++ - `-p, --path <path>: change root directory where command is executed to <path> directory `+ - `--config <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. `+ - `-s, --select: select sandbox template from interactive list `+ - `-t, --team <team-id>: specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). `+ - `-y, --yes: skip manual delete confirmation `++diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/errors/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/errors/page.mdxnew file mode 100644index 000000000..30340427c--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/errors/page.mdx@@ -0,0 +1,206 @@+# 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++***++### SandboxError++Base class for all sandbox errors.++Thrown when general sandbox errors occur.++#### Extended by++- `TimeoutError`+- `InvalidArgumentError`+- `NotEnoughSpaceError`+- `NotFoundError`+- `AuthenticationError`+- `TemplateError`++#### 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:2diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/filesystem/page.mdxnew file mode 100644index 000000000..33edf075d--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/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:399++##### 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:270++##### 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:308++##### 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:377++##### 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:339++##### 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:430++##### 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:76diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/sandbox/page.mdxnew file mode 100644index 000000000..6c4cae338--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/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:39diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/exceptions/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/exceptions/page.mdxnew file mode 100644index 000000000..9e3681b0d--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/exceptions/page.mdx@@ -0,0 +1,75 @@++++## SandboxException++```python+class SandboxException(Exception)+```++Base class for all sandbox errors.++Raised when a general sandbox exception occurs.+++## TimeoutException++```python+class TimeoutException(SandboxException)+```++Raised when a timeout occurs.++The [unavailable] exception type is caused by sandbox timeout.++The [canceled] exception type is caused by exceeding request timeout.++The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc.++The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly.+++## InvalidArgumentException++```python+class InvalidArgumentException(SandboxException)+```++Raised when an invalid argument is provided.+++## NotEnoughSpaceException++```python+class NotEnoughSpaceException(SandboxException)+```++Raised when there is not enough disk space.+++## NotFoundException++```python+class NotFoundException(SandboxException)+```++Raised when a resource is not found.+++## AuthenticationException++```python+class AuthenticationException(SandboxException)+```++Raised when authentication fails.+++## TemplateException++```python+class TemplateException(SandboxException)+```++Exception raised when the template uses old envd version. It isn't compatible with the new SDK.+diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_async/page.mdxnew file mode 100644index 000000000..fef236072--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_async/page.mdx@@ -0,0 +1,924 @@++++## SandboxApi++```python+class SandboxApi(SandboxApiBase)+```+++#### 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.++**Arguments**:++- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++List of running sandboxes+++++++## AsyncSandbox++```python+class AsyncSandbox(SandboxSetup, SandboxApi)+```++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).++Use the `AsyncSandbox.create()` to create a new sandbox.++**Example**:++```python+from e2b import AsyncSandbox++sandbox = await AsyncSandbox.create()+```+++#### files++```python+@property+def files() -> Filesystem+```++Module for interacting with the sandbox filesystem.+++#### commands++```python+@property+def commands() -> Commands+```++Module for running commands in the sandbox.+++#### pty++```python+@property+def pty() -> Pty+```++Module for interacting with the sandbox pseudo-terminal.+++#### sandbox\_id++```python+@property+def sandbox_id() -> str+```++Unique identifier of the sandbox.+++#### \_\_init\_\_++```python+def __init__(**opts: Unpack[AsyncSandboxOpts])+```++Use `AsyncSandbox.create()` to create a new sandbox instead.+++#### is\_running++```python+async def is_running(request_timeout: Optional[float] = None) -> bool+```++Check if the sandbox is running.++**Arguments**:++- `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+```+++#### create++```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)+```++Create a new sandbox.++By default, the sandbox is created from the default `base` sandbox template.++**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+- `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.+++#### connect++```python+@classmethod+async def connect(cls,+ sandbox_id: str,+ api_key: Optional[str] = None,+ domain: Optional[str] = None,+ debug: Optional[bool] = None)+```++Connect to an existing sandbox.++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**:++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 kill(request_timeout: Optional[float] = None) -> bool+```++Kill the sandbox.++**Arguments**:++- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++`True` if the sandbox was killed, `False` if the sandbox was not found+++#### kill++```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+```++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+++#### set\_timeout++```python+@overload+async def set_timeout(timeout: int,+ request_timeout: Optional[float] = None) -> None+```++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 `.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**:++- `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`.++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**:++- `sandbox_id`: Sandbox ID+- `timeout`: Timeout for the sandbox in **seconds**+- `request_timeout`: Timeout for the request in **seconds**+++++## AsyncWatchHandle++```python+class AsyncWatchHandle()+```++Handle for watching a directory in the sandbox filesystem.++Use `.stop()` to stop watching the directory.+++#### stop++```python+async def stop()+```++Stop watching the directory.+++++## Filesystem++```python+class Filesystem()+```++Module for interacting with the filesystem in the sandbox.+++#### read++```python+@overload+async def read(path: str,+ format: Literal["text"] = "text",+ user: Username = "user",+ request_timeout: Optional[float] = None) -> str+```++Read file content as a `str`.++**Arguments**:++- `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**:++File content as a `str`+++#### read++```python+@overload+async def read(path: str,+ format: Literal["bytes"],+ user: Username = "user",+ request_timeout: Optional[float] = None) -> bytearray+```++Read file content as a `bytearray`.++**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**++**Returns**:++File content as a `bytearray`+++#### read++```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**++**Returns**:++File content as an `AsyncIterator[bytes]`+++#### write++```python+async def write(path: str,+ data: Union[str, bytes, IO],+ user: Username = "user",+ request_timeout: Optional[float] = None) -> EntryInfo+```++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.++**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+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++Information about the written file+++#### list++```python+async def list(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> List[EntryInfo]+```++List entries in a directory.++**Arguments**:++- `path`: Path to the directory+- `user`: Run the operation as this user+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++List of entries in the directory+++#### exists++```python+async def exists(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> bool+```++Check if a file or a directory exists.++**Arguments**:++- `path`: Path to a file or a directory+- `user`: Run the operation as this user+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++`True` if the file or directory exists, `False` otherwise+++#### remove++```python+async def remove(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> None+```++Remove a file or a directory.++**Arguments**:++- `path`: Path to a file or a directory+- `user`: Run the operation as this user+- `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**:++Information about the renamed file or directory+++#### make\_dir++```python+async def make_dir(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> bool+```++Create a new directory and all directories along the way if needed on the specified path.++**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**:++`True` if the directory was created, `False` if the directory already exists+++#### watch\_dir++```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+```++Watch directory for filesystem events.++**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**:++`AsyncWatchHandle` object for stopping watching directory+++++## Pty++```python+class Pty()+```++Module for interacting with PTYs (pseudo-terminals) in the sandbox.+++#### kill++```python+async def kill(pid: int, request_timeout: Optional[float] = None) -> bool+```++Kill PTY.++**Arguments**:++- `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+++#### send\_stdin++```python+async def send_stdin(pid: int,+ data: bytes,+ request_timeout: Optional[float] = None) -> None+```++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**+++#### create++```python+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+```++Start a new PTY (pseudo-terminal).++**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**+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++Handle to interact with the PTY+++#### resize++```python+async def resize(pid: int,+ size: PtySize,+ request_timeout: Optional[float] = None)+```++Resize PTY.++Call this when the terminal window is resized and the number of columns and rows has changed.++**Arguments**:++- `pid`: Process ID of the PTY+- `size`: New size of the PTY+- `request_timeout`: Timeout for the request in **seconds**+++++## Commands++```python+class Commands()+```++Module for executing commands in the sandbox.+++#### list++```python+async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]+```++Lists all running commands and PTY sessions.++**Arguments**:++- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++List of running commands and PTY sessions+++#### kill++```python+async def kill(pid: int, request_timeout: Optional[float] = None) -> bool+```++Kill a running command specified by its process ID.++It uses `SIGKILL` signal to kill the command.++**Arguments**:++- `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**++**Returns**:++`True` if the command was killed, `False` if the command was not found+++#### send\_stdin++```python+async def send_stdin(pid: int,+ data: str,+ request_timeout: Optional[float] = None) -> None+```++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**++++#### run++```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+```++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**:++`CommandResult` result of the command execution+++#### run++```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+```++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+- `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**:++`AsyncCommandHandle` handle to interact with the running command+++#### connect++```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+```++Connects to a running command.++You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results.++**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++**Returns**:++`AsyncCommandHandle` handle to interact with the running command+++++## AsyncCommandHandle++```python+class AsyncCommandHandle()+```++Command execution handle.++It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.+++#### pid++```python+@property+def pid()+```++Command process ID.+++#### stdout++```python+@property+def stdout()+```++Command stdout output.+++#### stderr++```python+@property+def stderr()+```++Command stderr output.+++#### error++```python+@property+def error()+```++Command execution error message.+++#### exit\_code++```python+@property+def exit_code()+```++Command execution exit code.++`0` if the command finished successfully.++It is `None` if the command is still running.+++#### disconnect++```python+async def disconnect() -> None+```++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.+++#### wait++```python+async def wait() -> CommandResult+```++Wait for the command to finish and return the result.++If the command exits with a non-zero exit code, it throws a `CommandExitException`.++**Returns**:++`CommandResult` result of command execution+++#### kill++```python+async def kill() -> bool+```++Kills the command.++It uses `SIGKILL` signal to kill the command++**Returns**:++`True` if the command was killed successfully, `False` if the command was not found+diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_sync/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_sync/page.mdxnew file mode 100644index 000000000..12fdd0b3b--- /dev/null+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_sync/page.mdx@@ -0,0 +1,901 @@++++## SandboxApi++```python+class SandboxApi(SandboxApiBase)+```+++#### 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**:++- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++List of sandbox info+++++## Sandbox++```python+class Sandbox(SandboxSetup, SandboxApi)+```++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).++Use the `Sandbox()` to create a new sandbox.++**Example**:++```python+from e2b import Sandbox++sandbox = Sandbox()+```+++#### files++```python+@property+def files() -> Filesystem+```++Module for interacting with the sandbox filesystem.+++#### commands++```python+@property+def commands() -> Commands+```++Module for running commands in the sandbox.+++#### pty++```python+@property+def pty() -> Pty+```++Module for interacting with the sandbox pseudo-terminal.+++#### sandbox\_id++```python+@property+def sandbox_id() -> str+```++Unique identifier of the sandbox+++#### \_\_init\_\_++```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)+```++Create a new sandbox.++By default, the sandbox is created from the default `base` sandbox template.++**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+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++sandbox instance for the new sandbox+++#### is\_running++```python+def is_running(request_timeout: Optional[float] = None) -> bool+```++Check if the sandbox is running.++**Arguments**:++- `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+```+++#### connect++```python+@classmethod+def connect(cls,+ sandbox_id: str,+ api_key: Optional[str] = None,+ domain: Optional[str] = None,+ debug: Optional[bool] = None)+```++Connects to an existing Sandbox.++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**:++sandbox instance for the existing sandbox+@example+```python+sandbox = Sandbox()+sandbox_id = sandbox.sandbox_id++same_sandbox = Sandbox.connect(sandbox_id)+++#### kill++```python+@overload+def kill(request_timeout: Optional[float] = None) -> bool+```++Kill the sandbox.++**Arguments**:++- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++`True` if the sandbox was killed, `False` if the sandbox was not found+++#### kill++```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+```++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+++#### kill++```python+@class_method_variant("_cls_kill")+def kill(request_timeout: Optional[float] = None) -> bool+```++Kill the sandbox.++**Arguments**:++- `request_timeout`: Timeout for the request++**Returns**:++`True` if the sandbox was killed, `False` if the sandbox was not found+++#### set\_timeout++```python+@overload+def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None+```++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 `.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**:++- `timeout`: Timeout for the sandbox in **seconds**+- `request_timeout`: Timeout for the request in **seconds**+++#### set\_timeout++```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+```++Set the timeout of the sandbox specified by sandbox ID.++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**:++- `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**+++++## WatchHandle++```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.+++#### stop++```python+def stop()+```++Stop watching the directory.+After you stop the watcher you won't be able to get the events anymore.+++#### get\_new\_events++```python+def get_new_events() -> List[FilesystemEvent]+```++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 filesystem events+++++## Filesystem++```python+class Filesystem()+```++Module for interacting with the filesystem in the sandbox.+++#### read++```python+@overload+def read(path: str,+ format: Literal["text"] = "text",+ user: Username = "user",+ request_timeout: Optional[float] = None) -> str+```++Read file content as a `str`.++**Arguments**:++- `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**:++File content as a `str`+++#### read++```python+@overload+def read(path: str,+ format: Literal["bytes"],+ user: Username = "user",+ request_timeout: Optional[float] = None) -> bytearray+```++Read file content as a `bytearray`.++**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**++**Returns**:++File content as a `bytearray`+++#### read++```python+@overload+def read(path: str,+ format: Literal["stream"],+ user: Username = "user",+ request_timeout: Optional[float] = None) -> Iterator[bytes]+```++Read file content as a `Iterator[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**++**Returns**:++File content as an `Iterator[bytes]`+++#### write++```python+def write(path: str,+ data: Union[str, bytes, IO],+ user: Username = "user",+ request_timeout: Optional[float] = None) -> EntryInfo+```++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.++**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+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++Information about the written file+++#### list++```python+def list(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> List[EntryInfo]+```++List entries in a directory.++**Arguments**:++- `path`: Path to the directory+- `user`: Run the operation as this user+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++List of entries in the directory+++#### exists++```python+def exists(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> bool+```++Check if a file or a directory exists.++**Arguments**:++- `path`: Path to a file or a directory+- `user`: Run the operation as this user+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++`True` if the file or directory exists, `False` otherwise+++#### remove++```python+def remove(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> None+```++Remove a file or a directory.++**Arguments**:++- `path`: Path to a file or a directory+- `user`: Run the operation as this user+- `request_timeout`: Timeout for the request in **seconds**+++#### rename++```python+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**:++Information about the renamed file or directory+++#### make\_dir++```python+def make_dir(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> bool+```++Create a new directory and all directories along the way if needed on the specified path.++**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**:++`True` if the directory was created, `False` if the directory already exists+++#### watch\_dir++```python+def watch_dir(path: str,+ user: Username = "user",+ request_timeout: Optional[float] = None) -> WatchHandle+```++Watch directory for filesystem events.++**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+++++## Pty++```python+class Pty()+```++Module for interacting with PTYs (pseudo-terminals) in the sandbox.+++#### kill++```python+def kill(pid: int, request_timeout: Optional[float] = None) -> bool+```++Kill PTY.++**Arguments**:++- `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+++#### send\_stdin++```python+def send_stdin(pid: int,+ data: bytes,+ request_timeout: Optional[float] = None) -> None+```++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**+++#### create++```python+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+```++Start a new PTY (pseudo-terminal).++**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**+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++Handle to interact with the PTY+++#### resize++```python+def resize(pid: int,+ size: PtySize,+ 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.++**Arguments**:++- `pid`: Process ID of the PTY+- `size`: New size of the PTY+- `request_timeout`: Timeout for the request in **seconds**s+++++## Commands++```python+class Commands()+```++Module for executing commands in the sandbox.+++#### list++```python+def list(request_timeout: Optional[float] = None) -> List[ProcessInfo]+```++Lists all running commands and PTY sessions.++**Arguments**:++- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++List of running commands and PTY sessions+++#### kill++```python+def kill(pid: int, request_timeout: Optional[float] = None) -> bool+```++Kills a running command specified by its process ID.++It uses `SIGKILL` signal to kill the command.++**Arguments**:++- `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**++**Returns**:++`True` if the command was killed, `False` if the command was not found+++#### send\_stdin++```python+def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None)+```++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**++++#### run++```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+```++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**:++`CommandResult` result of the command execution+++#### run++```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+```++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**:++`CommandHandle` handle to interact with the running command+++#### connect++```python+def connect(pid: int,+ timeout: Optional[float] = 60,+ request_timeout: Optional[float] = None)+```++Connects to a running command.++You can use `CommandHandle.wait()` to wait for the command to finish and get execution results.++**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+- `request_timeout`: Timeout for the request in **seconds**++**Returns**:++`CommandHandle` handle to interact with the running command+++++## CommandHandle++```python+class CommandHandle()+```++Command execution handle.++It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command.+++#### pid++```python+@property+def pid()+```++Command process ID.+++#### \_\_iter\_\_++```python+def __iter__()+```++Iterate over the command output.++**Returns**:++Generator of command outputs+++#### disconnect++```python+def disconnect() -> None+```++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+def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None,+ on_stdout: Optional[Callable[[str], None]] = None,+ on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult+```++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**:++- `on_pty`: Callback for pty output+- `on_stdout`: Callback for stdout output+- `on_stderr`: Callback for stderr output++**Returns**:++`CommandResult` result of command execution+++#### kill++```python+def kill() -> bool+```++Kills the command.++It uses `SIGKILL` signal to kill the command.++**Returns**:++Whether the command was killed successfully+diff --git a/packages/cli/package.json b/packages/cli/package.jsonindex 3ea7182e6..e8b3ea7e9 100644--- a/packages/cli/package.json+++ b/packages/cli/package.json@@ -1,6 +1,6 @@{"name": "@e2b/cli",- "version": "0.5.11",+ "version": "1.0.0","description": "CLI for managing e2b sandbox templates","homepage": "https://e2b.dev","license": "MIT",diff --git a/packages/python-sdk/pyproject.toml b/packages/python-sdk/pyproject.tomlindex 611c04bce..a20b04383 100644--- a/packages/python-sdk/pyproject.toml+++ b/packages/python-sdk/pyproject.toml@@ -1,6 +1,6 @@[tool.poetry]name = "e2b"-version = "0.17.2a62"+version = "1.0.0"description = "E2B SDK that give agents cloud environments"authors = ["e2b <[email protected]>"]license = "MIT"