LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangSmith
  • Client
  • Run Trees
  • Traceable
  • Evaluation
  • Schemas
  • Langchain
  • Jest
  • Vitest
  • Wrappers
  • Anonymizer
  • Jestlike
  • Vercel
  • Anthropic
  • Sandbox
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangSmith
ClientRun TreesTraceableEvaluationSchemasLangchainJestVitestWrappersAnonymizerJestlikeVercelAnthropicSandbox
Language
Theme
JavaScriptlangsmithsandboxCreateSandboxOptions
Interface●Since v0.8

CreateSandboxOptions

Options for creating a sandbox.

Copy
interface CreateSandboxOptions

Properties

View source on GitHub
property
deleteAfterStopSeconds: number
property
fsCapacityBytes: number
property
idleTtlSeconds: number
property
memBytes: number
property
mountConfig: SandboxMountConfig
property
name: string
property
proxyConfig: SandboxProxyConfig
property
snapshotName: string
property
timeout: number
property
vCpus: number
property
waitForReady: boolean

Seconds after the sandbox enters the stopped state before it (and its filesystem clone) are permanently deleted. Must be a multiple of 60. Pass 0 to disable stop-anchored deletion (manual cleanup required). When omitted, the server applies its configured default (typically 14 days).

Filesystem capacity in bytes for Docker image export.

Idle timeout in seconds. The launcher stops the sandbox after this many seconds of inactivity. Must be a multiple of 60. Pass 0 to disable the idle stop. When omitted, the server applies a default of 600 seconds (10 minutes).

Memory in bytes for the temporary builder sandbox.

Mount configuration forwarded to the server as mount_config. The backend expands mount auth into runtime proxy rules. Explicit AWS/GCP proxy rules in proxyConfig conflict with mount auth for the same provider.

Per-sandbox proxy configuration. Use { access_control: { allow_list: ["github.com", "*.example.com"] } } to restrict outbound HTTPS to a set of host patterns. Forwarded to the server as-is on the wire. Use proxyConfig with provider rule helpers such as awsAuth for AWS SigV4 auth or gcpAuth for GCP OAuth bearer auth.

Optional snapshot name to boot from. Mutually exclusive with the positional snapshotId. Resolved server-side to a snapshot owned by the caller's tenant.

Number of vCPUs allocated.

Whether to wait for the sandbox to be ready before returning. When false, returns immediately with status "provisioning". Use getSandboxStatus() or waitForSandbox() to poll for readiness. Default: true.