Capture a snapshot from a sandbox

Error

A valid request URL is required to generate request examples

{
  "created_at": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "docker_image": "<string>",
  "fs_capacity_bytes": 123,
  "fs_used_bytes": 123,
  "id": "<string>",
  "image_digest": "<string>",
  "included": [
    "mounts"
  ],
  "labels": {},
  "memory_snapshot_size_bytes": 123,
  "mount_config": {
    "auth": {
      "aws": {
        "role_arn": "<string>",
        "subject_scope": "<string>"
      },
      "azure": {
        "tenant_id": "<string>",
        "client_id": "<string>",
        "subject_scope": "<string>"
      },
      "gcp": {
        "workload_identity_provider": "<string>",
        "service_account_email": "<string>",
        "subject_scope": "<string>"
      }
    },
    "mounts": [
      {
        "id": "<string>",
        "mount_path": "<string>",
        "s3": {
          "bucket": "<string>",
          "region": "<string>",
          "endpoint_url": "<string>",
          "path_style": true,
          "prefix": "<string>"
        },
        "type": "s3",
        "cache": {
          "max_size_bytes": 1,
          "writeback_seconds": 1
        },
        "encryption": {
          "kms_key": "<string>"
        },
        "read_only": true,
        "azure_blob": {
          "container": "<string>",
          "storage_account": "<string>",
          "prefix": "<string>"
        },
        "contexthub": {
          "repo": "<string>",
          "initial_pull_only": true
        },
        "gcs": {
          "bucket": "<string>",
          "prefix": "<string>"
        },
        "git": {
          "remote_url": "<string>",
          "ref": {
            "name": "<string>",
            "type": "branch"
          },
          "refresh_interval_seconds": 2
        }
      }
    ]
  },
  "name": "<string>",
  "proxy_config": {
    "access_control": {
      "allow_list": [
        "<string>"
      ],
      "deny_list": [
        "<string>"
      ]
    },
    "callbacks": [
      {
        "match_hosts": [
          "<string>"
        ],
        "ttl_seconds": 1830,
        "url": "<string>",
        "full_request": true,
        "request_headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ]
      }
    ],
    "description": "<string>",
    "no_proxy": [
      "<string>"
    ],
    "rules": [
      {
        "name": "<string>",
        "aws": {
          "role_arn": "<string>",
          "subject_scope": "<string>"
        },
        "azure": {
          "tenant_id": "<string>",
          "client_id": "<string>",
          "subject_scope": "<string>",
          "resources": [
            "https://storage.azure.com"
          ]
        },
        "description": "<string>",
        "enabled": true,
        "env_vars": {},
        "gcp": {
          "workload_identity_provider": "<string>",
          "service_account_email": "<string>",
          "subject_scope": "<string>",
          "scopes": [
            "<string>"
          ]
        },
        "headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ],
        "match_headers": [
          "<string>"
        ],
        "match_hosts": [
          "<string>"
        ],
        "match_paths": [
          "<string>"
        ],
        "relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rewrite": {
          "port": 32768,
          "credentials": "strip",
          "host": "<string>",
          "sandbox": "<string>"
        },
        "type": "<string>"
      }
    ]
  },
  "registry_id": "<string>",
  "run_config": {
    "env_vars": {},
    "user": "<string>",
    "work_dir": "<string>"
  },
  "source_sandbox_id": "<string>",
  "status": "<string>",
  "status_message": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>"
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

POST

api

sandboxes

boxes

{name}

snapshot

Error

A valid request URL is required to generate request examples

{
  "created_at": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "docker_image": "<string>",
  "fs_capacity_bytes": 123,
  "fs_used_bytes": 123,
  "id": "<string>",
  "image_digest": "<string>",
  "included": [
    "mounts"
  ],
  "labels": {},
  "memory_snapshot_size_bytes": 123,
  "mount_config": {
    "auth": {
      "aws": {
        "role_arn": "<string>",
        "subject_scope": "<string>"
      },
      "azure": {
        "tenant_id": "<string>",
        "client_id": "<string>",
        "subject_scope": "<string>"
      },
      "gcp": {
        "workload_identity_provider": "<string>",
        "service_account_email": "<string>",
        "subject_scope": "<string>"
      }
    },
    "mounts": [
      {
        "id": "<string>",
        "mount_path": "<string>",
        "s3": {
          "bucket": "<string>",
          "region": "<string>",
          "endpoint_url": "<string>",
          "path_style": true,
          "prefix": "<string>"
        },
        "type": "s3",
        "cache": {
          "max_size_bytes": 1,
          "writeback_seconds": 1
        },
        "encryption": {
          "kms_key": "<string>"
        },
        "read_only": true,
        "azure_blob": {
          "container": "<string>",
          "storage_account": "<string>",
          "prefix": "<string>"
        },
        "contexthub": {
          "repo": "<string>",
          "initial_pull_only": true
        },
        "gcs": {
          "bucket": "<string>",
          "prefix": "<string>"
        },
        "git": {
          "remote_url": "<string>",
          "ref": {
            "name": "<string>",
            "type": "branch"
          },
          "refresh_interval_seconds": 2
        }
      }
    ]
  },
  "name": "<string>",
  "proxy_config": {
    "access_control": {
      "allow_list": [
        "<string>"
      ],
      "deny_list": [
        "<string>"
      ]
    },
    "callbacks": [
      {
        "match_hosts": [
          "<string>"
        ],
        "ttl_seconds": 1830,
        "url": "<string>",
        "full_request": true,
        "request_headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ]
      }
    ],
    "description": "<string>",
    "no_proxy": [
      "<string>"
    ],
    "rules": [
      {
        "name": "<string>",
        "aws": {
          "role_arn": "<string>",
          "subject_scope": "<string>"
        },
        "azure": {
          "tenant_id": "<string>",
          "client_id": "<string>",
          "subject_scope": "<string>",
          "resources": [
            "https://storage.azure.com"
          ]
        },
        "description": "<string>",
        "enabled": true,
        "env_vars": {},
        "gcp": {
          "workload_identity_provider": "<string>",
          "service_account_email": "<string>",
          "subject_scope": "<string>",
          "scopes": [
            "<string>"
          ]
        },
        "headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ],
        "match_headers": [
          "<string>"
        ],
        "match_hosts": [
          "<string>"
        ],
        "match_paths": [
          "<string>"
        ],
        "relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rewrite": {
          "port": 32768,
          "credentials": "strip",
          "host": "<string>",
          "sandbox": "<string>"
        },
        "type": "<string>"
      }
    ]
  },
  "registry_id": "<string>",
  "run_config": {
    "env_vars": {},
    "user": "<string>",
    "work_dir": "<string>"
  },
  "source_sandbox_id": "<string>",
  "status": "<string>",
  "status_message": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>"
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": "<string>",
  "details": {
    "adapter": "<string>",
    "item_type": "<string>",
    "run_id": "<string>"
  },
  "error_class": "PARSE_FAILURE",
  "instance": "<string>",
  "remedy": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

name

string

required

Sandbox display name

Body

application/json

name

string

required

checkpoint

string

if omitted, creates a fresh checkpoint from the running VM

confirm_allow_snapshot_secret_values

boolean

Must be true when the included settings hold literal secret values (opaque values rather than workspace secret references, and any env var value), acknowledging that the snapshot stores them and every sandbox created from it can use them.

description

string

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.

Maximum string length: 1024

docker_image

string

sandbox-local Docker image to export

fs_capacity_bytes

integer

required for Docker image export unless the sandbox has a capacity

image_config

object

ImageConfig sets the command and ports the snapshot records, as a Docker image's ENTRYPOINT, CMD and EXPOSE do. By default a capture keeps those of the snapshot the sandbox was created from; each field given here replaces that one, and an empty list clears it. A function serving the snapshot runs this command and listens on its one exposed port.

Show child attributes

include

enum<string>[]

Sandbox settings to carry into the snapshot. Sandboxes created from it start with each carried setting their create request leaves unset: "mounts" (the mount_config, with its auth), "proxy_config", "env_vars", "resources" (CPU and memory), "lifecycle" (idle_ttl_seconds, delete_after_stop_seconds, preserve_memory_on_stop), and "labels" (merged under this request's labels; reserved com.langchain.* labels are left out). "all" names every one of these. VM memory is captured with include_memory, not here. Warning: mounts, proxy_config and env_vars carry the sandbox's credentials, and every sandbox created from the snapshot can use them.

Available options:

all,

mounts,

proxy_config,

env_vars,

resources,

lifecycle,

labels

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.

labels

object

Labels seed the captured snapshot's labels.

Show child attributes

run_config

object

RunConfig overrides the runtime configuration the snapshot carries: for a docker_image export, the image's USER, WORKDIR and ENV; for a capture of the running VM, the sandbox's own. user and work_dir replace, env_vars merge.

Show child attributes

tag

string

mutable Docker-style tag; defaults to "latest"

Response

Created

created_at

string

created_by

string

description

string

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

docker_image

string

fs_capacity_bytes

integer

fs_used_bytes

integer

string

image_digest

string

included

enum<string>[]

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.

Available options:

mounts,

proxy_config,

env_vars,

resources,

lifecycle,

labels

labels

object

Show child attributes

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.

mount_config

object

The mount_config sandboxes created from this snapshot start with when their create request has none, with secret values redacted. Present only on snapshots captured with include "mounts" or "all" from a sandbox that had mounts.

Show child attributes

name

string

proxy_config

object

The proxy_config sandboxes created from this snapshot start with when their create request has none, with secret values redacted. Present only on snapshots captured with include "proxy_config" or "all".

Show child attributes

registry_id

string

run_config

object

RunConfig is what sandboxes from this snapshot boot with. Absent on snapshots built before it was recorded, which run as root with their own env.

Show child attributes

source_sandbox_id

string

status

string

status_message

string

SmithDB SDK migration

LangSmith REST API

Capture a snapshot from a sandbox

Authorizations

Path Parameters

Body

Response