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
JavaScriptlangsmithsandboxSandboxClientlistSnapshots
Method●Since v0.8

listSnapshots

List snapshots, optionally filtered and paginated server-side.

The backend always paginates this endpoint. When limit is omitted the server applies a default page size (currently 50), so a single call is not guaranteed to return every snapshot visible to the tenant. To iterate through all results, repeat the call with increasing offset values (or an explicit limit) until fewer than limit snapshots come back.

Copy
listSnapshots(options: ListSnapshotsOptions = {}): Promise<Snapshot[]>

Parameters

NameTypeDescription
optionsListSnapshotsOptions
Default:{}

Optional filter/pagination options.

  • nameContains: case-insensitive substring match on snapshot name.
  • limit: page size; must be between 1 and 500 (inclusive). Defaults to 50 server-side when omitted.
  • offset: number of snapshots to skip; must be >= 0.

Values outside those ranges are rejected by the server.

Example

Copy
const firstPage = await client.listSnapshots();
const page = await client.listSnapshots({
  nameContains: "python",
  limit: 100,
  offset: 0,
});
View source on GitHub