Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/adapters/anthropic.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: Anthropic
id: anthropic-adapter
order: 2
description: "Use Anthropic Claude models with TanStack AI — Claude Sonnet 4.5, Claude Opus, and more via the @tanstack/ai-anthropic adapter."
keywords:
- tanstack ai
- anthropic
- claude
- claude sonnet 4.5
- claude opus
- adapter
- llm
---

The Anthropic adapter provides access to Claude models, including Claude Sonnet 4.5, Claude Opus 4.5, and more.
Expand Down
9 changes: 9 additions & 0 deletions docs/adapters/elevenlabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: ElevenLabs
id: elevenlabs-adapter
order: 9
description: "Build realtime voice-to-voice conversational AI with ElevenLabs agents in TanStack AI via the @tanstack/ai-elevenlabs adapter."
keywords:
- tanstack ai
- elevenlabs
- realtime voice ai
- conversational ai
- voice chat
- voice agents
- adapter
---

The ElevenLabs adapter provides realtime conversational voice AI for TanStack AI. Unlike text-focused adapters, the ElevenLabs adapter is **voice-focused** -- it integrates with TanStack AI's realtime system to enable voice-to-voice conversations. It does not support `chat()`, `embedding()`, or `summarize()`.
Expand Down
10 changes: 10 additions & 0 deletions docs/adapters/fal.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
---
title: fal.ai
id: fal-adapter
description: "Generate images and videos with 600+ models on fal.ai using TanStack AI — Nano Banana Pro, FLUX, and more via the @tanstack/ai-fal adapter."
keywords:
- tanstack ai
- fal.ai
- fal
- image generation
- video generation
- flux
- nano banana
- adapter
---

The fal.ai adapter provides access to 600+ models on the fal.ai platform for image generation and video generation. Unlike text-focused adapters, the fal adapter is **media-focused** — it supports `generateImage()` and `generateVideo()` but does not support `chat()` or tools. Audio and speech support are coming soon.
Expand Down
10 changes: 10 additions & 0 deletions docs/adapters/gemini.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
title: Google Gemini
id: gemini-adapter
order: 3
description: "Use Google Gemini with TanStack AI — text, image generation via Imagen and Gemini native (NanoBanana), and experimental TTS via @tanstack/ai-gemini."
keywords:
- tanstack ai
- gemini
- google gemini
- imagen
- nano banana
- image generation
- adapter
- google ai
---

The Google Gemini adapter provides access to Google's Gemini models, including text generation, image generation with both Imagen and Gemini native image models (NanoBanana), and experimental text-to-speech.
Expand Down
9 changes: 9 additions & 0 deletions docs/adapters/grok.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: Grok (xAI)
id: grok-adapter
order: 5
description: "Use xAI Grok models with TanStack AI — Grok 4.1, Grok 4, Grok 3, and Grok 2 Image generation via @tanstack/ai-grok."
keywords:
- tanstack ai
- grok
- xai
- grok 4
- grok 4.1
- image generation
- adapter
---

The Grok adapter provides access to xAI's Grok models, including Grok 4.1, Grok 4, Grok 3, and image generation with Grok 2 Image.
Expand Down
9 changes: 9 additions & 0 deletions docs/adapters/groq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: Groq
id: groq-adapter
order: 6
description: "Use Groq's fast inference API with TanStack AI for low-latency LLM responses — Llama and other open-weight models via @tanstack/ai-groq."
keywords:
- tanstack ai
- groq
- fast inference
- llama
- low latency
- adapter
- llm
---

The Groq adapter provides access to Groq's fast inference API, featuring the world's fastest LLM inference.
Expand Down
10 changes: 10 additions & 0 deletions docs/adapters/ollama.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
title: Ollama
id: ollama-adapter
order: 4
description: "Run local LLMs with Ollama in TanStack AI for private, no-cost AI on your own hardware via the @tanstack/ai-ollama adapter."
keywords:
- tanstack ai
- ollama
- local llm
- self-hosted
- privacy
- llama
- offline ai
- adapter
---

The Ollama adapter provides access to local models running via Ollama, allowing you to run AI models on your own infrastructure with full privacy and no API costs.
Expand Down
11 changes: 11 additions & 0 deletions docs/adapters/openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@
title: OpenAI
id: openai-adapter
order: 1
description: "Use OpenAI models with TanStack AI — GPT-4o, GPT-5, DALL-E image generation, TTS, and Whisper transcription via @tanstack/ai-openai."
keywords:
- tanstack ai
- openai
- gpt-4o
- gpt-5
- dall-e
- whisper
- openai tts
- adapter
- chatgpt
---

The OpenAI adapter provides access to OpenAI's models, including GPT-4o, GPT-5, image generation (DALL-E), text-to-speech (TTS), and audio transcription (Whisper).
Expand Down
9 changes: 9 additions & 0 deletions docs/adapters/openrouter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
---
title: OpenRouter Adapter
id: openrouter-adapter
description: "Access 300+ LLMs from OpenAI, Anthropic, Google, Meta, Mistral, and more through a single API with OpenRouter in TanStack AI."
keywords:
- tanstack ai
- openrouter
- multi-provider
- unified api
- llm gateway
- 300 models
- adapter
---

OpenRouter is TanStack AI's first official AI partner and the recommended starting point for most projects. It provides access to 300+ models from OpenAI, Anthropic, Google, Meta, Mistral, and many more — all through a single API key and unified interface.
Expand Down
9 changes: 9 additions & 0 deletions docs/advanced/extend-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: Extend Adapter
id: extend-adapter
order: 7
description: "Extend TanStack AI adapter factories with custom model IDs and fine-tuned models while keeping full type safety for input modalities and provider options."
keywords:
- tanstack ai
- extendAdapter
- custom models
- fine-tuned models
- createModel
- type safety
- adapter factory
---

# Extending Adapters with Custom Models
Expand Down
10 changes: 10 additions & 0 deletions docs/advanced/middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
title: Middleware
id: middleware
order: 1
description: "Hook into every stage of TanStack AI's chat() lifecycle with middleware — logging, analytics, stream transforms, tool interception, and side effects."
keywords:
- tanstack ai
- middleware
- chat middleware
- lifecycle hooks
- observability
- logging
- tool interception
- stream transform
---

Middleware lets you hook into every stage of the `chat()` lifecycle — from configuration to streaming, tool execution, usage tracking, and completion. You can observe, transform, or short-circuit behavior at each stage without modifying your adapter or tool implementations.
Expand Down
11 changes: 11 additions & 0 deletions docs/advanced/multimodal-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@
title: Multimodal Content
id: multimodal-content
order: 3
description: "Send images, audio, video, and documents alongside text in TanStack AI messages with typed ContentPart primitives for multimodal models."
keywords:
- tanstack ai
- multimodal
- vision
- images
- audio
- video
- documents
- ContentPart
- ImagePart
---

TanStack AI supports multimodal content in messages, allowing you to send images, audio, video, and documents alongside text to AI models that support these modalities.
Expand Down
9 changes: 9 additions & 0 deletions docs/advanced/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: Observability
id: observability
order: 2
description: "Subscribe to TanStack AI events for observability and debugging — tool calls, streaming chunks, usage, and errors via the type-safe event client."
keywords:
- tanstack ai
- observability
- event client
- telemetry
- debugging
- tracing
- devtools
---

# Event client
Expand Down
9 changes: 9 additions & 0 deletions docs/advanced/per-model-type-safety.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: Per-Model Type Safety
id: per-model-type-safety
order: 4
description: "TanStack AI narrows modelOptions and content types to the specific model you select, enforcing capabilities at compile time."
keywords:
- tanstack ai
- type safety
- per-model types
- modelOptions
- typescript
- autocomplete
- compile-time
---

The AI SDK provides **model-specific type safety** for `modelOptions`. Each model's capabilities determine which model options are allowed, and TypeScript will enforce this at compile time.
Expand Down
8 changes: 8 additions & 0 deletions docs/advanced/runtime-adapter-switching.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: Runtime Adapter Switching
id: runtime-adapter-switching
order: 5
description: "Let users switch between LLM providers at runtime in TanStack AI while keeping full TypeScript type safety for each adapter's model options."
keywords:
- tanstack ai
- runtime switching
- multi-provider
- adapter factory
- type safety
- dynamic adapter
---

# Runtime Adapter Switching with Type Safety
Expand Down
8 changes: 8 additions & 0 deletions docs/advanced/tree-shaking.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: Tree-Shaking
id: tree-shaking
order: 6
description: "TanStack AI's tree-shakeable architecture — import only the activities and adapters you use for minimal bundle size across chat, image, and speech."
keywords:
- tanstack ai
- tree-shaking
- bundle size
- modular imports
- performance
- tree-shakeable
---

# Tree-Shaking & Bundle Optimization
Expand Down
9 changes: 9 additions & 0 deletions docs/api/ai-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: "@tanstack/ai-client"
slug: /api/ai-client
order: 2
description: "API reference for @tanstack/ai-client — the framework-agnostic headless client for managing chat state and streaming transports."
keywords:
- tanstack ai
- "@tanstack/ai-client"
- headless client
- ChatClient
- chat state
- connection adapters
- api reference
---

Framework-agnostic headless client for managing chat state and streaming.
Expand Down
8 changes: 8 additions & 0 deletions docs/api/ai-preact.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: "@tanstack/ai-preact"
slug: /api/ai-preact
order: 5
description: "API reference for @tanstack/ai-preact — Preact hooks including useChat for streaming chat with full type safety in Preact apps."
keywords:
- tanstack ai
- "@tanstack/ai-preact"
- preact
- useChat
- preact hooks
- api reference
---

Preact hooks for TanStack AI, providing convenient Preact bindings for the headless client.
Expand Down
8 changes: 8 additions & 0 deletions docs/api/ai-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: "@tanstack/ai-react"
slug: /api/ai-react
order: 3
description: "API reference for @tanstack/ai-react — React hooks including useChat for streaming chat with full type safety in React apps."
keywords:
- tanstack ai
- "@tanstack/ai-react"
- react
- useChat
- react hooks
- api reference
---

React hooks for TanStack AI, providing convenient React bindings for the headless client.
Expand Down
9 changes: 9 additions & 0 deletions docs/api/ai-solid.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: "@tanstack/ai-solid"
slug: /api/ai-solid
order: 4
description: "API reference for @tanstack/ai-solid — SolidJS primitives including useChat for streaming chat with full type safety."
keywords:
- tanstack ai
- "@tanstack/ai-solid"
- solidjs
- solid
- useChat
- solid primitives
- api reference
---

SolidJS primitives for TanStack AI, providing convenient SolidJS bindings for the headless client.
Expand Down
9 changes: 9 additions & 0 deletions docs/api/ai-svelte.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: "@tanstack/ai-svelte"
id: ai-svelte
order: 6
description: "API reference for @tanstack/ai-svelte — Svelte 5 reactive factory functions for streaming chat built on runes."
keywords:
- tanstack ai
- "@tanstack/ai-svelte"
- svelte
- svelte 5
- createChat
- runes
- api reference
---

Svelte 5 bindings for TanStack AI, providing reactive factory functions for the headless client using Svelte runes.
Expand Down
9 changes: 9 additions & 0 deletions docs/api/ai-vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: "@tanstack/ai-vue"
id: ai-vue
order: 5
description: "API reference for @tanstack/ai-vue — Vue 3 composables including useChat for streaming chat with full type safety."
keywords:
- tanstack ai
- "@tanstack/ai-vue"
- vue
- vue 3
- useChat
- composables
- api reference
---

Vue composables for TanStack AI, providing convenient Vue 3 bindings for the headless client.
Expand Down
9 changes: 9 additions & 0 deletions docs/api/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
title: "@tanstack/ai"
id: tanstack-ai-api
order: 1
description: "API reference for @tanstack/ai — the core TanStack AI library providing chat(), generateImage(), toolDefinition(), and streaming utilities."
keywords:
- tanstack ai
- "@tanstack/ai"
- api reference
- chat
- toolDefinition
- generateImage
- core library
---

The core AI library for TanStack AI.
Expand Down
15 changes: 15 additions & 0 deletions docs/architecture/approval-flow-processing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
---
title: Approval Flow Processing Architecture
id: approval-flow-processing
description: "Internal architecture of TanStack AI's tool approval system — state machine, streaming protocol, concurrency control, and chained approval mechanics."
keywords:
- tanstack ai
- approval flow
- tool approval
- architecture
- state machine
- streaming protocol
- internals
- concurrency
---

# Approval Flow Processing Architecture

> Internal architecture reference for the tool approval system in TanStack AI.
Expand Down
Loading
Loading