LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
  • Stream
LangGraph SDK
  • Ui
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Utils
  • Server
  • Stream
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
  • Store
LangGraph Checkpoint Redis
  • Shallow
  • Store
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
  • Cli
LangGraph API
LangGraph CLI
LangGraph CUA
  • Utils
LangGraph Supervisor
LangGraph Swarm
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangGraph
WebChannelsPregelPrebuiltRemoteStream
LangGraph SDK
UiClientAuthReactLoggingReact UiUtilsServerStream
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
Store
LangGraph Checkpoint Redis
ShallowStore
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
Cli
LangGraph API
LangGraph CLI
LangGraph CUA
Utils
LangGraph Supervisor
LangGraph Swarm
Language
Theme
JavaScript@langchain/langgraph-sdkclientBaseClient
Classā—Since v1.9

BaseClient

Copy
class BaseClient

Constructors

Properties

Methods

View source on GitHub
constructor
constructor
property
apiUrl: string
property
asyncCaller: AsyncCaller
property
defaultHeaders: Record<string, HeaderValue>
property
onRequest: RequestHook
property
streamProtocol: StreamProtocol
property
timeoutMs: number | undefined
method
fetch
method
prepareFetchOptions
method
streamWithRetry

Retries and concurrency for SSE/command HTTP. When omitted, requests use raw fetch with no automatic retries (same as constructing ProtocolSseTransportAdapter without this option).

Headers applied to every request.

The configured API key, when present, is added as the x-api-key header after these defaults are initialized.

Hook for inspecting or mutating a request before it is sent.

Receives the resolved URL and prepared RequestInit; return the original init or a replacement object to continue the request.

Streaming protocol used by stream-capable endpoints.

Defaults to "legacy" for backwards compatibility.

Default timeout, in milliseconds, applied to client requests.

Per-request timeoutMs values override this default. Passing null at the request level disables the configured timeout for that request.