LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Agent
  • Middleware
  • Backends
  • Sandboxes
  • Skills
  • Subagents
  • Types
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
  • Vitest
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewAgentMiddlewareBackendsSandboxesSkillsSubagentsTypes
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
Vitest
Language
Theme
JavaScriptdeepagentsbackendsSandboxBackendProtocolV1
Interface●Since v1.9Deprecated

SandboxBackendProtocolV1

Protocol for sandboxed backends with isolated runtime. Sandboxed backends run in isolated environments (e.g., containers) and communicate via defined interfaces.

Copy
interface SandboxBackendProtocolV1

Bases

BackendProtocolV1

Properties

property
id: string

Unique identifier for the sandbox backend instance

Methods

method
delete→ MaybePromise<DeleteResult>

Delete a path, recursively removing anything nested under it.

This method is optional. Backends that do not implement it should omit it; callers that need broad backend compatibility should check for support before calling.

method
downloadFiles→ MaybePromise<FileDownloadResponse[]>

Download multiple files. Optional - backends that don't support file download can omit this.

method
edit→ MaybePromise<EditResult>

Edit a file by replacing string occurrences.

method
execute→ MaybePromise<ExecuteResponse>

Execute a command in the sandbox.

method
globInfo→ MaybePromise<FileInfo[]>

Structured glob matching returning FileInfo objects.

method
grepRaw→ MaybePromise<string | GrepMatch[]>

Search file contents for a literal text pattern.

Binary files (determined by MIME type) are skipped.

method
lsInfo→ MaybePromise<FileInfo[]>

Structured listing with file metadata.

Lists files and directories in the specified directory (non-recursive). Directories have a trailing / in their path and is_dir=true.

method
read→ MaybePromise<string>

Read file content.

method
readRaw→ MaybePromise<FileData>

Read file content as raw FileData.

method
uploadFiles→ MaybePromise<FileUploadResponse[]>

Upload multiple files. Optional - backends that don't support file upload can omit this.

method
write→ MaybePromise<WriteResult>

Write content to a file, creating it or overwriting it if it already exists.

Inherited fromBackendProtocolV1

Methods

Mdelete→ MaybePromise<DeleteResult>
—

Delete a path, recursively removing anything nested under it.

MdownloadFiles→ MaybePromise<FileDownloadResponse[]>
—

Download multiple files.

Medit→ MaybePromise<EditResult>
—

Edit a file by replacing string occurrences.

MglobInfo→ MaybePromise<FileInfo[]>
—

Structured glob matching returning FileInfo objects.

MgrepRaw→ MaybePromise<string | GrepMatch[]>
—

Search file contents for a literal text pattern.

MlsInfo→ MaybePromise<FileInfo[]>
—

Structured listing with file metadata.

Mread→ MaybePromise<string>
—

Read file content.

MreadRaw→ MaybePromise<FileData>
—

Read file content as raw FileData.

MuploadFiles→ MaybePromise<FileUploadResponse[]>
—

Upload multiple files.

Mwrite→ MaybePromise<WriteResult>
—

Write content to a file, creating it or overwriting it if it already exists.

View source on GitHub