LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
  • Stream
LangGraph SDK
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Server
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
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
ClientAuthReactLoggingReact UiServer
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
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/langgraphwebToolCallStream
Interface●Since v1.3

ToolCallStream

Stable handle for one tool call: name, arguments, and async results.

Emitted when content-block-finish delivers a finalized tool_call block.

Copy
interface ToolCallStream

Properties

property
callId: string

Correlates with protocol toolCallId when the runtime provides one.

property
error: Promise<string | undefined>

Resolves to an error message string if ToolCallStream.status is "error", otherwise undefined.

property
input: TInput

Arguments passed to the tool (finalized when the call is observable).

property
name: TName

Tool identifier as registered on the graph or model schema.

property
output: Promise<TOutput>

Resolves to the tool return value on success.

Rejection or hang semantics depend on the runner; pairing with ToolCallStream.status and ToolCallStream.error is recommended.

property
status: Promise<ToolCallStatus>

Resolves to ToolCallStatus when the call leaves the running state.

View source on GitHub