LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangSmith
  • Client
  • Run Trees
  • Traceable
  • Evaluation
  • Schemas
  • Langchain
  • Jest
  • Vitest
  • Wrappers
  • Anonymizer
  • Jestlike
  • Vercel
  • Anthropic
  • Sandbox
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangSmith
ClientRun TreesTraceableEvaluationSchemasLangchainJestVitestWrappersAnonymizerJestlikeVercelAnthropicSandbox
Language
Theme
JavaScriptlangsmith_openapi_clientresourcesSandboxesBoxes
Class●Since v0.8

Boxes

Copy
class Boxes

Bases

APIResource

Constructors

constructor
constructor

Properties

property
_client: Langsmith

Methods

method
create→ APIPromise<ItemCreateResponse>

Add RUN or THREAD items to a single annotation queue. RUN items require run_id unless they are created from a suggested example. THREAD items require thread_id and project_id.

method
createSnapshot→ APIPromise<SnapshotResponse>

Create a snapshot by capturing the current state of a sandbox or promoting an existing checkpoint.

method
delete→ APIPromise<Rsp>
method
generateServiceURL→ APIPromise<ServiceURLResponse>

Create a short-lived JWT for accessing an HTTP service running on a specific port inside a sandbox. Returns a browser_url (sets auth cookie via redirect), a service_url (for use with the X-Langsmith-Sandbox-Service-Token header), the raw token, and its expiry.

method
getStatus→ APIPromise<SandboxStatusResponse>

Retrieve the lightweight status of a sandbox for polling.

method
list→ PagePromise<ItemListResponsesItemsCursorGetPagination, ItemListResponse>

List RUN and THREAD items in a single annotation queue for one review status section, with opaque cursor pagination. Optional item_type=RUN|THREAD filters the page. direction=backward returns items before the supplied cursor. The response contains item metadata only, not expanded run or thread payloads. status=archived returns items whose queue review requirements have been satisfied, not merely items the caller personally marked completed.

method
retrieve→ APIPromise<Run>

Alpha: The request and response contract may change; Returns one run within the trace identified by the share token. The request supplies only the run ID and that run's exact start_time coordinate.

method
start→ APIPromise<SandboxResponse>

Start a stopped or failed sandbox. This endpoint is not idempotent.

method
stop→ APIPromise<void>

Stop a ready sandbox. This endpoint is not idempotent; the filesystem is preserved for later restart.

method
update→ APIPromise<ItemUpdateResponse>

Partially update mutable timestamps (added_at, last_reviewed_time) for a RUN or THREAD annotation queue item. Omit a field, or pass JSON null, to leave it unchanged.

View source on GitHub