Skip to main content
PATCH
Error

Authorizations

X-API-Key
string
header
required

Path Parameters

name
string
required

Current sandbox display name

Body

application/json
cpu_millicores
integer
delete_after_stop_seconds
integer
fs_capacity_bytes
integer
idle_ttl_seconds
integer
Required range: 0 <= x <= 2147483640
mem_bytes
integer

New memory for the sandbox, in bytes. The 4 GiB per vCPU ratio applies when the sandbox is created; a resize enforces only the maximum of 64 GiB.

name
string
proxy_config
object
run_config
object

RunConfig changes what subsequent commands run with: user and work_dir replace the current values, env_vars merge over them. Commands already running are unaffected.

tag_value_ids
string[]
vcpus
integer

Response

OK

access_delegation
object

AccessDelegation is the LangSmith access this sandbox was granted, absent when it has none. It is reported exactly as it was requested at create.

cpu_millicores
integer
created_at
string
created_by
string
dataplane_url
string
delete_after_stop_seconds
integer
fs_capacity_bytes
integer
id
string
idle_ttl_seconds
integer
labels
object
mem_bytes
integer
mount_config
object
name
string
persistent
boolean

Persistent reports whether the sandbox keeps its filesystem across stops. When false, its writes are discarded whenever it stops and it is not charged for storage.

preserve_memory_on_stop
boolean
proxy_config
object
run_config
object

RunConfig is what the sandbox's commands run with: the user, working directory and base env beneath env_vars.

size_class
string
snapshot_id
string
status
string
status_message
string
stopped_at
string
updated_at
string
updated_by
string
vcpus
integer
volumes
object[]

Volumes (beta) are the volumes attached to the sandbox, in slot order. Absent when the workspace does not have sandbox volumes enabled.