LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
React SDK
Vue SDK
Svelte SDK
Angular SDK
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
WebChannelsPregelPrebuiltRemote
React SDK
Vue SDK
Svelte SDK
Angular SDK
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-sdkclientRunsClient
Class●Since v0.0

RunsClient

Copy
class RunsClient

Bases

BaseClient

Constructors

Properties

Methods

Inherited fromBaseClient

Properties

PapiUrl: string
—

Base URL of the LangGraph API server.

PasyncCallerPdefaultHeaders: Record<string, HeaderValue>
—

Headers applied to every request.

PonRequest
View source on GitHub
: RequestHook
—

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

PstreamProtocol: StreamProtocol
—

Streaming protocol used by stream-capable endpoints.

PtimeoutMs: number
—

Default timeout, in milliseconds, applied to client requests.

Methods

MfetchMprepareFetchOptionsMstreamWithRetry
constructor
constructor
property
apiUrl: string
property
asyncCaller: AsyncCaller
property
defaultHeaders: Record<string, HeaderValue>
property
onRequest: RequestHook
property
streamProtocol: StreamProtocol
property
timeoutMs: number | undefined
method
cancel→ Promise<void>
method
cancelMany→ Promise<void>
method
create→ Promise<Assistant>
method
createBatch→ Promise<Run[]>
method
delete→ Promise<void>
method
fetch
method
get→ Promise<Assistant>
method
join→ Promise<TStateType>
method
joinStream→ AsyncGenerator<__type>
method
list→ Promise<Run[]>
method
prepareFetchOptions
method
stream→ TypedAsyncGenerator<TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType>
method
streamWithRetry
method
wait→ Promise<DefaultValues>

Base URL of the LangGraph API server.

Defaults to http://localhost:8123, unless the runtime provides a langgraph_api:url global override.

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.

Cancel a run.

Cancel one or more runs.

Create a new assistant.

Create a batch of stateless background runs.

Delete an assistant.

Get an assistant by ID.

Block until a run is done.

Stream output from a run in real-time, until the run is done.

List all runs for a thread.

Create a run and stream the results.

Create a run and wait for it to complete.