sandboxes

Get a sandbox

Changed on

Retrieve a sandbox by name. Stale provisioning sandboxes are auto-failed.

get/api/v2/sandboxes/boxes/{name}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v2/sandboxes/boxes/{name}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer
    • or X-Service-Key (a scheme the document does not define)

Path parameters

namestring required

Sandbox display name

Response

OK

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

  • dfe647d1748eRevision 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

  • 1a8ee9358d81Revision changes
    • info

      endpoint added