TanStack
AI
v0
v0
Search...
K
Auto
Log In
Start
RC
Start
RC
Home
Docs
GitHub
Router
Router
Home
Docs
GitHub
Query
Query
Home
Docs
GitHub
Table
Table
Home
Docs
GitHub
DB
beta
DB
beta
Home
Docs
GitHub
AI
alpha
AI
alpha
Home
Docs
GitHub
Form
new
Form
new
Home
Docs
GitHub
Virtual
Virtual
Home
Docs
GitHub
Pacer
beta
Pacer
beta
Home
Docs
GitHub
Store
alpha
Store
alpha
Home
Docs
GitHub
Devtools
alpha
Devtools
alpha
Home
Docs
GitHub
More Libraries
More Libraries
Feed
Beta
Feed
Beta
Maintainers
Maintainers
Partners
Partners
Showcase
Showcase
Blog
Blog
Learn
NEW
Learn
NEW
Support
Support
Stats
Stats
Discord
Discord
Merch
Merch
GitHub
GitHub
Ethos
Ethos
Tenets
Tenets
Brand Guide
Brand Guide
Docs
Partners
React
Latest
Search...
K
Menu
Home
Frameworks
Contributors
GitHub
Discord
Getting Started
Overview
Quick Start: React
Devtools
Quick Start: Vue
Quick Start: Svelte
Quick Start: Server Only
Comparison
TanStack AI vs Vercel AI SDK
Tools
Tools
Tool Architecture
Server Tools
Client Tools
Tool Approval Flow
Lazy Tool Discovery
Chat & Streaming
Agentic Cycle
Streaming
Connection Adapters
Structured Outputs
Thinking & Reasoning
Code Mode
Code Mode
Showing Code Mode in the UI
Code Mode with Skills
Code Mode Isolate Drivers
Media
Generations
Realtime Voice Chat
Text-to-Speech
Transcription
Image Generation
Video Generation
Generation Hooks
Advanced
Middleware
Observability
Multimodal Content
Per-Model Type Safety
Runtime Adapter Switching
Tree-Shaking
Extend Adapter
Migration
Migration Guide
API
@tanstack/ai
@tanstack/ai-client
@tanstack/ai-react
@tanstack/ai-solid
@tanstack/ai-preact
@tanstack/ai-vue
@tanstack/ai-svelte
Adapters
OpenAI
Anthropic
Google Gemini
Ollama
Grok (xAI)
Groq
ElevenLabs
fal.ai
OpenRouter Adapter
Community Adapters
Community Adapters Guide
Decart
Cencori
Cloudflare
Soniox
Mynth
Class References
BaseAdapter
BatchStrategy
CompositeStrategy
ImmediateStrategy
PartialJSONParser
PunctuationStrategy
StreamProcessor
ToolCallManager
RealtimeClient
WordBoundaryStrategy
Function References
text
textOptions
combineStrategies
convertMessagesToModelMessages
convertZodToJsonSchema
createReplayStream
embedding
generateMessageId
maxIterations
messages
modelMessageToUIMessage
modelMessagesToUIMessages
normalizeToUIMessage
parsePartialJSON
summarize
toServerSentEventsStream
toServerSentEventsResponse
toolDefinition
uiMessageToModelMessages
realtimeToken
untilFinishReason
Interface References
AIAdapter
AIAdapterConfig
AgentLoopState
ApprovalRequestedStreamChunk
AudioPart
AudioVisualization
BaseStreamChunk
TextCompletionChunk
TextOptions
ChunkRecording
ChunkStrategy
ClientTool
ContentPartSource
ContentStreamChunk
DefaultMessageMetadataByModality
DocumentPart
DoneStreamChunk
EmbeddingOptions
EmbeddingResult
ErrorStreamChunk
ImagePart
InternalToolCallState
JSONParser
ModelMessage
ProcessorResult
ProcessorState
RealtimeAdapter
RealtimeClientOptions
RealtimeConnection
RealtimeMessage
RealtimeSessionConfig
RealtimeToken
RealtimeTokenAdapter
RealtimeTokenOptions
ResponseFormat
ServerTool
StreamProcessorEvents
StreamProcessorHandlers
StreamProcessorOptions
SummarizationOptions
SummarizationResult
TextPart
ThinkingPart
ThinkingStreamChunk
Tool
ToolCall
ToolCallPart
ToolCallStreamChunk
ToolConfig
ToolDefinition
ToolDefinitionConfig
ToolDefinitionInstance
ToolInputAvailableStreamChunk
ToolResultPart
ToolResultStreamChunk
UIMessage
VideoPart
Type Alias References
AgentLoopStrategy
AnyClientTool
TextStreamOptionsForModel
TextStreamOptionsUnion
ConstrainedContent
ConstrainedModelMessage
ContentPart
ContentPartForModalities
ExtractModalitiesForModel
ExtractModelsFromAdapter
InferToolInput
InferToolName
InferToolOutput
MessagePart
RealtimeEvent
RealtimeMessagePart
RealtimeMode
RealtimeStatus
ModalitiesArrayToUnion
Modality
StreamChunk
StreamChunkType
ToolCallState
ToolResultState
Variable References
aiEventClient
defaultJSONParser
latest
React
Latest
Menu
Home
Frameworks
Contributors
GitHub
Discord
Getting Started
Overview
Quick Start: React
Devtools
Quick Start: Vue
Quick Start: Svelte
Quick Start: Server Only
Comparison
TanStack AI vs Vercel AI SDK
Tools
Tools
Tool Architecture
Server Tools
Client Tools
Tool Approval Flow
Lazy Tool Discovery
Chat & Streaming
Agentic Cycle
Streaming
Connection Adapters
Structured Outputs
Thinking & Reasoning
Code Mode
Code Mode
Showing Code Mode in the UI
Code Mode with Skills
Code Mode Isolate Drivers
Media
Generations
Realtime Voice Chat
Text-to-Speech
Transcription
Image Generation
Video Generation
Generation Hooks
Advanced
Middleware
Observability
Multimodal Content
Per-Model Type Safety
Runtime Adapter Switching
Tree-Shaking
Extend Adapter
Migration
Migration Guide
API
@tanstack/ai
@tanstack/ai-client
@tanstack/ai-react
@tanstack/ai-solid
@tanstack/ai-preact
@tanstack/ai-vue
@tanstack/ai-svelte
Adapters
OpenAI
Anthropic
Google Gemini
Ollama
Grok (xAI)
Groq
ElevenLabs
fal.ai
OpenRouter Adapter
Community Adapters
Community Adapters Guide
Decart
Cencori
Cloudflare
Soniox
Mynth
Class References
BaseAdapter
BatchStrategy
CompositeStrategy
ImmediateStrategy
PartialJSONParser
PunctuationStrategy
StreamProcessor
ToolCallManager
RealtimeClient
WordBoundaryStrategy
Function References
text
textOptions
combineStrategies
convertMessagesToModelMessages
convertZodToJsonSchema
createReplayStream
embedding
generateMessageId
maxIterations
messages
modelMessageToUIMessage
modelMessagesToUIMessages
normalizeToUIMessage
parsePartialJSON
summarize
toServerSentEventsStream
toServerSentEventsResponse
toolDefinition
uiMessageToModelMessages
realtimeToken
untilFinishReason
Interface References
AIAdapter
AIAdapterConfig
AgentLoopState
ApprovalRequestedStreamChunk
AudioPart
AudioVisualization
BaseStreamChunk
TextCompletionChunk
TextOptions
ChunkRecording
ChunkStrategy
ClientTool
ContentPartSource
ContentStreamChunk
DefaultMessageMetadataByModality
DocumentPart
DoneStreamChunk
EmbeddingOptions
EmbeddingResult
ErrorStreamChunk
ImagePart
InternalToolCallState
JSONParser
ModelMessage
ProcessorResult
ProcessorState
RealtimeAdapter
RealtimeClientOptions
RealtimeConnection
RealtimeMessage
RealtimeSessionConfig
RealtimeToken
RealtimeTokenAdapter
RealtimeTokenOptions
ResponseFormat
ServerTool
StreamProcessorEvents
StreamProcessorHandlers
StreamProcessorOptions
SummarizationOptions
SummarizationResult
TextPart
ThinkingPart
ThinkingStreamChunk
Tool
ToolCall
ToolCallPart
ToolCallStreamChunk
ToolConfig
ToolDefinition
ToolDefinitionConfig
ToolDefinitionInstance
ToolInputAvailableStreamChunk
ToolResultPart
ToolResultStreamChunk
UIMessage
VideoPart
Type Alias References
AgentLoopStrategy
AnyClientTool
TextStreamOptionsForModel
TextStreamOptionsUnion
ConstrainedContent
ConstrainedModelMessage
ContentPart
ContentPartForModalities
ExtractModalitiesForModel
ExtractModelsFromAdapter
InferToolInput
InferToolName
InferToolOutput
MessagePart
RealtimeEvent
RealtimeMessagePart
RealtimeMode
RealtimeStatus
ModalitiesArrayToUnion
Modality
StreamChunk
StreamChunkType
ToolCallState
ToolResultState
Variable References
aiEventClient
defaultJSONParser
Learn about TanStack Ads
Hide Ads
Interface References
On this page
ToolConfig
Copy page
Interface: ToolConfig
Defined in:
types.ts:505
Indexable
ts
[key: string]: Tool<SchemaInput, SchemaInput, string>
Edit on GitHub
Previous
ToolCallStreamChunk
Next
ToolDefinition
On this page
Interface: ToolConfig
Indexable
Learn about TanStack Ads
Hide Ads
Partners
Become a Partner
Learn about TanStack Ads
Hide Ads