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-sdkclientHttpAgentServerAdapterOptions
Interfaceā—Since v1.9

HttpAgentServerAdapterOptions

Copy
interface HttpAgentServerAdapterOptions

Properties

View source on GitHub
property
apiUrl: string
property
asyncCaller: AsyncCaller
property
defaultHeaders: Record<string, ProtocolHeaderValue>
property
fetch: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response>
property
onRequest: ProtocolRequestHook
property
paths: ProtocolTransportPaths
property
threadId: string
property
webSocketFactory: (url: string) => WebSocket

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.

Optional fetch override, forwarded to the SSE transport. Useful for auth proxies, Next.js route handlers, or tests with injected mocks. Ignored when webSocketFactory is also supplied.

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.

Override the default /threads/:threadId/... protocol paths.

Thread ID this transport currently targets.

Optional WebSocket factory. Supplying it flips the adapter into WebSocket mode — SSE is bypassed entirely.