Skip to content

armgit / E2B

Public Imported from GitHub
0

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

Improve metadata dosctrings; Export metadata type in JS SDK

Tomas Valentac86b79a1c586
diff --git a/packages/js-sdk/src/index.ts b/packages/js-sdk/src/index.ts
index b4b31c839..db28f2795 100644
--- a/packages/js-sdk/src/index.ts
+++ b/packages/js-sdk/src/index.ts
@@ -27,6 +27,7 @@ export { DataAnalysis as CodeInterpreter }
export { Artifact, DataAnalysis } from './templates/dataAnalysis'
export type { RunPythonOpts } from './templates/dataAnalysis'
+export type { SandboxMetadata } from './sandbox/sandboxConnection'
export type { Action } from './sandbox/index'
export { Sandbox }
diff --git a/packages/js-sdk/src/sandbox/sandboxConnection.ts b/packages/js-sdk/src/sandbox/sandboxConnection.ts
index c41162451..a4aee6dfc 100644
--- a/packages/js-sdk/src/sandbox/sandboxConnection.ts
+++ b/packages/js-sdk/src/sandbox/sandboxConnection.ts
@@ -60,6 +60,10 @@ export interface SandboxConnectionOpts {
apiKey?: string;
cwd?: string;
envVars?: EnvVars;
+ /**
+ * A dictionary of strings that is stored alongside the running sandbox.
+ * You can see this metadata when you list running sandboxes.
+ */
metadata?: SandboxMetadata;
logger?: Logger;
__sandbox?: components['schemas']['Sandbox'];
diff --git a/packages/python-sdk/e2b/sandbox/main.py b/packages/python-sdk/e2b/sandbox/main.py
index d3b0ec83b..6df0478d7 100644
--- a/packages/python-sdk/e2b/sandbox/main.py
+++ b/packages/python-sdk/e2b/sandbox/main.py
@@ -99,7 +99,7 @@ class Sandbox(SandboxConnection):
:param on_stdout: A default callback that is called when stdout with a newline is received from the process
:param on_stderr: A default callback that is called when stderr with a newline is received from the process
:param on_exit: A default callback that is called when the process exits
- :param metadata: A dictionary of metadata to be used for the sandbox
+ :param metadata: A dictionary of strings that is stored alongside the running sandbox. You can see this metadata when you list running sandboxes.
:param timeout: Timeout for sandbox to initialize in seconds, default is 60 seconds
"""