sandboxes

Start a stopped or failed sandbox. This endpoint is not idempotent. The optional volumes field is beta and requires sandbox volumes to be enabled for your workspace. Omit it to keep attachments, or send an empty array to detach all volumes. Changing attachments requires a stopped or failed sandbox, runtime access to it (its creator or sandboxes:exec), and, for each newly attached volume, being its creator or holding sandboxes:exec. A start whose volumes differ from those the sandbox's saved memory was captured with fails with 409 unless discard_memory is set, which cold-boots the sandbox without that memory.

post/api/v2/sandboxes/boxes/{name}/start

Request

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

Path parameters

namestring required

Sandbox display name

Request body

discard_memoryboolean

DiscardMemory cold-boots the sandbox, discarding any memory saved when it stopped.

Response

Accepted

cpu_millicoresinteger
created_atstring
created_bystring
dataplane_urlstring
delete_after_stop_secondsinteger
fs_capacity_bytesinteger
idstring
idle_ttl_secondsinteger
labelsSandboxesLabels
mem_bytesinteger
mount_configSandboxesSandboxMountConfig (unresolved $ref)
namestring
persistentboolean

Persistent (private beta) 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_stopboolean
size_classstring
snapshot_idstring
statusstring
status_messagestring
stopped_atstring
updated_atstring
updated_bystring
vcpusinteger

Changes

    • info

      added optional request body

    • info

      added the non-success 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

    • info

      added the optional property to the response with the status

    • info

      endpoint added