LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmithsandbox_clientSandboxClientcapture_snapshot
Method●Since v0.7

capture_snapshot

Copy
capture_snapshot(
  self,
  sandbox_name: str,
  name: str,
  *,
  docker_image: Optional
View source on GitHub
[
str
]
=
None
,
fs_capacity_bytes
:
Optional
[
int
]
=
None
,
timeout
:
int
=
60
,
headers
:
RequestHeaders
=
None
)
->
Snapshot

Parameters

NameTypeDescription
sandbox_name*str

Name of the sandbox to capture from.

name*str

Snapshot name.

docker_imageOptional[str]
Default:None

Optional Docker image tag inside the sandbox to export into the snapshot instead of capturing the live root filesystem.

fs_capacity_bytesOptional[int]
Default:None
timeoutint
Default:60

Capture a snapshot from a running sandbox.

Blocks until the snapshot is ready (polls with 2s interval).

Filesystem capacity in bytes for Docker image export.

Timeout in seconds when waiting for ready.