Skip to main content
POST
/
v2
/
sandboxes
/
boxes
/
{name}
/
snapshot
Error
A valid request URL is required to generate request examples
{
  "created_at": "<string>",
  "created_by": "<string>",
  "docker_image": "<string>",
  "fs_capacity_bytes": 123,
  "fs_used_bytes": 123,
  "id": "<string>",
  "image_digest": "<string>",
  "memory_snapshot_size_bytes": 123,
  "name": "<string>",
  "registry_id": "<string>",
  "source_sandbox_id": "<string>",
  "status": "<string>",
  "status_message": "<string>",
  "updated_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
name
string
required

Sandbox claim display name

Body

application/json
​
name
string
required
​
checkpoint
string

if omitted, creates a fresh checkpoint from the running VM

​
include_memory
boolean

IncludeMemory, when true, captures a full VM memory snapshot alongside the filesystem clone. Only honored when the sandbox is running AND Checkpoint is omitted (i.e. a fresh in-VM checkpoint is requested). Defaults to false to keep snapshots small unless memory restore is explicitly desired.

Response

Created

​
created_at
string
​
created_by
string
​
docker_image
string
​
fs_capacity_bytes
integer
​
fs_used_bytes
integer
​
id
string
​
image_digest
string
​
memory_snapshot_size_bytes
integer

MemorySnapshotSizeBytes is non-nil iff the snapshot was captured with VM memory state. A non-nil value is the canonical signal that this snapshot can warm-restore from memory; nil means rootfs only.

​
name
string
​
registry_id
string
​
source_sandbox_id
string
​
status
string
​
status_message
string
​
updated_at
string