sandboxes

Create a snapshot

Changed on

Create a snapshot from a Docker image (async build). Names use lowercase registry-style components separated by slashes, up to 255 characters. The system/ namespace is read-only.

post/api/v2/sandboxes/snapshots

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v2/sandboxes/snapshots
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Request body

descriptionstring

Description says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary. At most 1024 characters.

docker_imagestring required
fs_capacity_bytesinteger required
labelsSandboxesLabels
namestring required
registry_idstring
tagstring

mutable Docker-style tag; defaults to "latest"

Response

Created

created_atstring
created_bystring
descriptionstring

Description says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary.

docker_imagestring
fs_capacity_bytesinteger
fs_used_bytesinteger
idstring
image_digeststring
includedstring[]

The settings this snapshot carries, in include terms: sandboxes created from it start with each one their create request leaves unset. Env var values are never returned.

labelsSandboxesLabels
memory_snapshot_size_bytesinteger

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.

mount_configSandboxesSandboxMountConfig (unresolved $ref)
namestring
registry_idstring
source_sandbox_idstring
statusstring
status_messagestring
tagsstring[]

Tags currently resolving to this snapshot, under Name. A snapshot with no tags is dangling — addressable only by id.

updated_atstring

Changes

  • dfe647d1748eRevision changes
    • info

      added the optional property /////// to the response with the status

  • 9aeaab9f0a28Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status