LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Agent
  • Middleware
  • Backends
  • Sandboxes
  • Skills
  • Subagents
  • Configuration
  • 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

OverviewAgentMiddlewareBackendsSandboxesSkillsSubagentsConfigurationTypes
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
Vitest
Language
Theme
JavaScriptdeepagentsbackendsSandboxListResponse
Interface●Since v1.7

SandboxListResponse

Paginated response from a sandbox list operation.

This structure supports cursor-based pagination for efficiently browsing large collections of sandboxes.

Copy
interface SandboxListResponse

Example

Copy
const response: SandboxListResponse = {
  items: [
    { sandboxId: "sb_001", metadata: { status: "running" } },
    { sandboxId: "sb_002", metadata: { status: "stopped" } },
  ],
  cursor: "eyJvZmZzZXQiOjEwMH0=",
};

// Fetch next page
const nextResponse = await provider.list({ cursor: response.cursor });

Properties

property
cursor: string | null

Continuation token from a previous list() call. Pass undefined to start from the beginning.

property
items: SandboxInfo<MetadataT>[]

List of sandbox metadata objects for the current page

View source on GitHub