create(
self,
*,
access_delegation: box_create_params.AccessDelegation | Omit| Name | Type | Description |
|---|---|---|
access_delegation | box_create_params.AccessDelegation | Omit | Default: omitAccessDelegation lets code inside the sandbox call the LangSmith API as you, with at most the permissions granted here. Omit for no access. |
cpu_millicores | int | Omit | Default: omitCPUMillicores optionally requests CPU at millicore granularity (e.g. 500 = 0.5 vCPU); takes precedence over VCPUs. Fractional (sub-vCPU) values are not available for every sandbox. |
labels | Dict[str, str] | Omit | Default: omit |
mem_bytes | int | Omit | Default: omit |
preserve_memory_on_stop | bool | Omit | Default: omit |
restore_memory | bool | Omit | Default: omit |
run_config | box_create_params.RunConfig | Omit | Default: omit |
snapshot | str | Omit | Default: omit |
snapshot_name | str | Omit | Default: omit |
extra_headers | Headers | None | Default: None |
extra_query | Query | None | Default: None |
extra_body | Body | None | Default: None |
timeout | float | httpx.Timeout | None | NotGiven | Default: not_given |
Create a new sandbox from a snapshot.
Provide at most one of snapshot_id or
snapshot_name; if neither is provided, the server uses the default snapshot.
snapshot_name accepts a Docker-style name or name:tag reference (a bare
name resolves to name:latest).
Labels are free-form key/value metadata persisted with the sandbox and returned on reads. Labels from the source snapshot are inherited unless overridden here.
Memory for the sandbox, in bytes. Memory is tied to CPU at 4 GiB per vCPU: omit it and it follows that ratio; set it and it must stay within 50% of the ratio for the requested CPU, so a 1 vCPU sandbox accepts 2-6 GiB. Setting memory without CPU derives the CPU from the same ratio. Maximum 64 GiB.
PreserveMemoryOnStop, when true, suspends the sandbox's memory on a voluntary stop (idle timeout or explicit stop) so the next start resumes from where it left off. Default false discards memory and keeps only the filesystem, so the next start is a cold boot. Restarts triggered by infrastructure maintenance always preserve memory regardless of this setting.
RestoreMemory selects how the sandbox handles a snapshot's captured memory:
nil → if-present: resume from memory when the snapshot has it, else cold-boot (default). true → always: resume from memory; rejected if the snapshot has none. false → never: always cold-boot.
Applies to this request only.
RunConfig overrides the snapshot's run config for this sandbox: user and work_dir replace the snapshot's, env_vars merge over it. The result is what the sandbox boots with, and what a snapshot captured from it carries.
Snapshot is a Docker-style name or name:tag reference to boot from. A bare name resolves to name:latest.
SnapshotName is a synonym for Snapshot, accepted for compatibility with clients that predate it. Set one or the other.
Send extra headers
Add additional query parameters to the request
Add additional JSON properties to the request
Override the client-level default timeout for this request, in seconds