Options for creating a sandbox.
interface CreateSandboxOptionsGrant letting code inside the sandbox call the LangSmith API as you, with
no API key of its own. { mode: "INHERIT" } grants everything you can do;
{ mode: "EXPLICIT", permissions: [...] } grants only the permissions
listed, each of which you must already hold. The grant belongs to the
sandbox, so anyone who can exec into it can make calls under it. Omit for
no access.
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).
Root filesystem capacity in bytes.
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.
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.
Optional sandbox name (auto-generated if not provided).
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.
User, working directory and environment the sandbox boots with,
overriding the snapshot's: user and work_dir replace, env_vars
merge. The sandbox's own env vars remain a layer above this one.
Optional snapshot name to boot from. Mutually exclusive with the positional
snapshotId.
Resolved server-side to a snapshot owned by the caller's tenant.
Timeout in seconds when waiting for ready.
Number of vCPUs.
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.