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_clientSandboxClientcreate_snapshot
Methodā—Since v0.7

create_snapshot

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

Parameters

NameTypeDescription
name*str

Snapshot name.

docker_image*str

Docker image to build from (e.g., "python:3.12-slim").

fs_capacity_bytes*int

Filesystem capacity in bytes.

registry_idOptional[str]
Default:None
registry_urlOptional[str]
Default:None
registry_usernameOptional[str]
Default:None
registry_passwordOptional[str]
Default:None
timeoutint
Default:60

Build a snapshot from a Docker image.

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

Private registry ID (alternative to URL/credentials).

Registry URL for private images.

Registry username.

Registry password.

Timeout in seconds when waiting for ready.