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 SDK API reference doc versions

github-actions[bot]661a08f8ff75
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/auth/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/auth/page.mdx
new file mode 100644
index 000000000..5e547262c
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/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/v0.5.10/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/sandbox/page.mdx
new file mode 100644
index 000000000..060e6969c
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/sandbox/page.mdx
@@ -0,0 +1,84 @@
+# 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>
+```
+
+
+# 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. The available loggers are process, filesystem, terminal, network, file. Specify multiple loggers by separating them with a comma. [default: process,filesystem]`
+
+
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/template/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/template/page.mdx
new file mode 100644
index 000000000..48d3dcb2e
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/cli/v0.5.10/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/v0.16.2-beta.52/errors/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/errors/page.mdx
new file mode 100644
index 000000000..5f2546641
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/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
+
+Thrown when a sandbox error occurs.
+
+Base class for all sandbox errors.
+
+#### 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 process, 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/v0.16.2-beta.52/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/filesystem/page.mdx
new file mode 100644
index 000000000..09bd7a7ed
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/filesystem/page.mdx
@@ -0,0 +1,359 @@
+# sandbox/filesystem
+
+## Enumerations
+
+### FileType
+
+#### Enumeration Members
+
+##### DIR
+
+> **DIR**: `"dir"`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:34
+
+##### FILE
+
+> **FILE**: `"file"`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:33
+
+## Classes
+
+### 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:60
+
+#### Methods
+
+##### exists()
+
+> **exists**(`path`, `opts`?): `Promise`\<`boolean`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:214
+
+##### list()
+
+> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`EntryInfo`[]\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:132
+
+##### makeDir()
+
+> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:159
+
+##### read()
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`string`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`string`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:68
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`Uint8Array`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:69
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`Blob`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`Blob`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:70
+
+###### read(path, opts)
+
+> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`ReadableStream`\<`Uint8Array`\>\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:71
+
+##### remove()
+
+> **remove**(`path`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:203
+
+##### rename()
+
+> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\>
+
+###### Parameters
+
+• **oldPath**: `string`
+
+• **newPath**: `string`
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:178
+
+##### watch()
+
+> **watch**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **onEvent**
+
+• **opts?**: `FilesystemRequestOpts` & `object`
+
+###### Returns
+
+`Promise`\<`WatchHandle`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:233
+
+##### write()
+
+> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\>
+
+###### Parameters
+
+• **path**: `string`
+
+• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\>
+
+• **opts?**: `FilesystemRequestOpts`
+
+###### Returns
+
+`Promise`\<`EntryInfo`\>
+
+###### Defined in
+
+sandbox/filesystem/index.ts:98
+
+## Interfaces
+
+### EntryInfo
+
+#### Properties
+
+##### name
+
+> **name**: `string`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:27
+
+##### path
+
+> **path**: `string`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:29
+
+##### type?
+
+> `optional` **type**: `FileType`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:28
+
+***
+
+### FilesystemRequestOpts
+
+#### Extended by
+
+- `WatchOpts`
+
+#### Properties
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:14
+
+##### user?
+
+> `optional` **user**: `Username`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:47
+
+***
+
+### WatchOpts
+
+#### Properties
+
+##### onExit()?
+
+> `optional` **onExit**: (`err`) => `void`
+
+###### Parameters
+
+• **err**: `Error`
+
+###### Returns
+
+`void`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:52
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:14
+
+##### timeout?
+
+> `optional` **timeout**: `number`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:51
+
+##### user?
+
+> `optional` **user**: `Username`
+
+###### Defined in
+
+sandbox/filesystem/index.ts:47
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/process/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/process/page.mdx
new file mode 100644
index 000000000..354462a37
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/process/page.mdx
@@ -0,0 +1,23 @@
+# sandbox/process
+
+## References
+
+### Process
+
+Re-exports Process
+
+### ProcessConnectOpts
+
+Re-exports ProcessConnectOpts
+
+### ProcessInfo
+
+Re-exports ProcessInfo
+
+### ProcessRequestOpts
+
+Re-exports ProcessRequestOpts
+
+### ProcessStartOpts
+
+Re-exports ProcessStartOpts
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/pty/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/pty/page.mdx
new file mode 100644
index 000000000..83f1cdb85
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/pty/page.mdx
@@ -0,0 +1,165 @@
+# sandbox/pty
+
+## Classes
+
+### Pty
+
+#### Constructors
+
+##### new Pty()
+
+> **new Pty**(`transport`, `connectionConfig`): `Pty`
+
+###### Parameters
+
+• **transport**: `Transport`
+
+• **connectionConfig**: `ConnectionConfig`
+
+###### Returns
+
+`Pty`
+
+###### Defined in
+
+sandbox/pty.ts:29
+
+#### Methods
+
+##### create()
+
+> **create**(`opts`): `Promise`\<`ProcessHandle`\>
+
+###### Parameters
+
+• **opts**: `PtyCreateOpts`
+
+###### Returns
+
+`Promise`\<`ProcessHandle`\>
+
+###### Defined in
+
+sandbox/pty.ts:33
+
+##### resize()
+
+> **resize**(`pid`, `size`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **pid**: `number`
+
+• **size**
+
+• **size.cols**: `number`
+
+• **size.rows?**: `number`
+
+• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/pty.ts:107
+
+##### sendInput()
+
+> **sendInput**(`pid`, `data`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **pid**: `number`
+
+• **data**: `Uint8Array`
+
+• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/pty.ts:84
+
+## Interfaces
+
+### PtyCreateOpts
+
+#### Properties
+
+##### cols
+
+> **cols**: `number`
+
+###### Defined in
+
+sandbox/pty.ts:17
+
+##### cwd?
+
+> `optional` **cwd**: `string`
+
+###### Defined in
+
+sandbox/pty.ts:23
+
+##### envs?
+
+> `optional` **envs**: `Record`\<`string`, `string`\>
+
+###### Defined in
+
+sandbox/pty.ts:22
+
+##### onData()
+
+> **onData**: (`data`) => `void` \| `Promise`\<`void`\>
+
+###### Parameters
+
+• **data**: `Uint8Array`
+
+###### Returns
+
+`void` \| `Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/pty.ts:19
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:14
+
+##### rows
+
+> **rows**: `number`
+
+###### Defined in
+
+sandbox/pty.ts:18
+
+##### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+###### Defined in
+
+sandbox/pty.ts:20
+
+##### user?
+
+> `optional` **user**: `Username`
+
+###### Defined in
+
+sandbox/pty.ts:21
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/sandbox/page.mdx
new file mode 100644
index 000000000..ba54cc153
--- /dev/null
+++ b/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v0.16.2-beta.52/sandbox/page.mdx
@@ -0,0 +1,367 @@
+# sandbox
+
+## Classes
+
+### Sandbox
+
+#### Constructors
+
+##### new Sandbox()
+
+> **new Sandbox**(`opts`): `Sandbox`
+
+###### Parameters
+
+• **opts**: `Omit`\<`SandboxOpts`, `"metadata"` \| `"envs"` \| `"timeoutMs"`\> & `object`
+
+###### Returns
+
+`Sandbox`
+
+###### Defined in
+
+sandbox/index.ts:33
+
+#### Properties
+
+##### commands
+
+> `readonly` **commands**: `Process`
+
+###### Defined in
+
+sandbox/index.ts:22
+
+##### files
+
+> `readonly` **files**: `Filesystem`
+
+###### Defined in
+
+sandbox/index.ts:21
+
+##### pty
+
+> `readonly` **pty**: `Pty`
+
+###### Defined in
+
+sandbox/index.ts:23
+
+##### sandboxId
+
+> `readonly` **sandboxId**: `string`
+
+###### Defined in
+
+sandbox/index.ts:25
+
+#### Methods
+
+##### downloadUrl()
+
+> **downloadUrl**(`path`): `string`
+
+###### Parameters
+
+• **path**: `string`
+
+###### Returns
+
+`string`
+
+###### Defined in
+
+sandbox/index.ts:125
+
+##### getHost()
+
+> **getHost**(`port`): `string`
+
+###### Parameters
+
+• **port**: `number`
+
+###### Returns
+
+`string`
+
+###### Defined in
+
+sandbox/index.ts:76
+
+##### isRunning()
+
+> **isRunning**(`opts`?): `Promise`\<`boolean`\>
+
+###### Parameters
+
+• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/index.ts:84
+
+##### kill()
+
+> **kill**(`opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/index.ts:112
+
+##### setTimeout()
+
+> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **timeoutMs**: `number`
+
+• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/index.ts:103
+
+##### uploadUrl()
+
+> **uploadUrl**(`path`?): `string`
+
+###### Parameters
+
+• **path?**: `string`
+
+###### Returns
+
+`string`
+
+###### Defined in
+
+sandbox/index.ts:121
+
+##### connect()
+
+> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **sandboxId**: `string`
+
+• **opts?**: `Omit`\<`SandboxOpts`, `"metadata"` \| `"envs"` \| `"timeoutMs"`\>
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+###### Defined in
+
+sandbox/index.ts:69
+
+##### create()
+
+###### create(this, opts)
+
+> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **opts?**: `SandboxOpts`
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+###### Defined in
+
+sandbox/index.ts:52
+
+###### create(this, template, opts)
+
+> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\>
+
+###### Type Parameters
+
+• **S** *extends* *typeof* `Sandbox`
+
+###### Parameters
+
+• **this**: `S`
+
+• **template**: `string`
+
+• **opts?**: `SandboxOpts`
+
+###### Returns
+
+`Promise`\<`InstanceType`\<`S`\>\>
+
+###### Defined in
+
+sandbox/index.ts:53
+
+##### kill()
+
+> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\>
+
+Kills sandbox specified by sandbox ID.
+
+###### Parameters
+
+• **sandboxId**: `string`
+
+Sandbox ID.
+
+• **opts?**: `SandboxApiOpts`
+
+Connection options.
+
+###### Returns
+
+`Promise`\<`boolean`\>
+
+###### Defined in
+
+sandbox/sandboxApi.ts:47
+
+##### list()
+
+> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\>
+
+###### Parameters
+
+• **opts?**: `SandboxApiOpts`
+
+###### Returns
+
+`Promise`\<`SandboxInfo`[]\>
+
+###### Defined in
+
+sandbox/sandboxApi.ts:72
+
+##### setTimeout()
+
+> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\>
+
+###### Parameters
+
+• **sandboxId**: `string`
+
+• **timeoutMs**: `number`
+
+• **opts?**: `SandboxApiOpts`
+
+###### Returns
+
+`Promise`\<`void`\>
+
+###### Defined in
+
+sandbox/sandboxApi.ts:94
+
+## Interfaces
+
+### SandboxOpts
+
+#### Properties
+
+##### accessToken?
+
+> `optional` **accessToken**: `string`
+
+###### Defined in
+
+connectionConfig.ts:11
+
+##### apiKey?
+
+> `optional` **apiKey**: `string`
+
+###### Defined in
+
+connectionConfig.ts:10
+
+##### debug?
+
+> `optional` **debug**: `boolean`
+
+###### Defined in
+
+connectionConfig.ts:13
+
+##### domain?
+
+> `optional` **domain**: `string`
+
+###### Defined in
+
+connectionConfig.ts:12
+
+##### envs?
+
+> `optional` **envs**: `Record`\<`string`, `string`\>
+
+###### Defined in
+
+sandbox/index.ts:13
+
+##### logger?
+
+> `optional` **logger**: `Logger`
+
+###### Defined in
+
+connectionConfig.ts:15
+
+##### metadata?
+
+> `optional` **metadata**: `Record`\<`string`, `string`\>
+
+###### Defined in
+
+sandbox/index.ts:12
+
+##### requestTimeoutMs?
+
+> `optional` **requestTimeoutMs**: `number`
+
+###### Defined in
+
+connectionConfig.ts:14
+
+##### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+###### Defined in
+
+sandbox/index.ts:14
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_async/page.mdx
index c30a981d6..9087bf077 100644
--- a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_async/page.mdx
+++ b/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v0.17.1/sandbox_async/page.mdx
@@ -200,9 +200,9 @@ Send data to process stdin
```python
async def create(
size: PtySize,
+ on_data: OutputHandler[PtyOutput],
user: Username = "user",
cwd: Optional[str] = None,
- on_data: Optional[Callable[[bytes], None]] = None,
envs: Optional[Dict[str, str]] = None,
timeout: Optional[float] = 60,
request_timeout: Optional[float] = None) -> AsyncProcessHandle