Skip to main content

AI SDK

Menu

Home
GitHub(opens in a new tab)

AI SDK by Vercel

AI SDK by Vercel

Foundations

Foundations
Overview
Providers and Models
Prompts
Tools
Streaming
Provider Options

Getting Started

Getting Started
Choosing a Provider
Navigating the Library
Next.js App Router
Svelte
Vue.js (Nuxt)
Node.js
Expo
Angular
TanStack Start
Coding Agents
Next.js Pages Router

Agents

Agents
Overview
Building Agents
Workflow Patterns
Loop Control
Configuring Call Options
Memory
Policy-Based Tool Approvals
Subagents
Tool Approvals
WorkflowAgent
Terminal UI
Chat Platforms

AI SDK Core

AI SDK Core
Overview
Generating Text
Generating Structured Data
Tool Calling
Model Context Protocol (MCP)
MCP Apps
MCP Events
Runtime and Tool Context
Code Mode
Tools
Tool Search
Prompt Engineering
Settings
Reasoning
Embeddings
Reranking
Decisions
Image Generation
Realtime
Transcription
Translation
Speech
Video Generation
File Uploads
Language Model Middleware
Skill Uploads
Batch
Provider & Model Management
Error Handling
Testing
Telemetry
DevTools
Lifecycle Callbacks

AI SDK Harnesses

AI SDK Harnesses
Overview
HarnessAgent
Tools
Skills
Harness Adapters
Workflow Utilities
UI
Terminal UI

AI SDK UI

AI SDK UI
Overview
Chatbot
Chatbot Message Persistence
Chatbot Resume Streams
Chatbot Tool Usage
Generative User Interfaces
Completion
Object Generation
Streaming Custom Data
Error Handling
Transport
Reading UIMessage Streams
Message Metadata
Stream Protocols

AI SDK RSC

AI SDK RSC
Overview
Streaming React Components
Managing Generative UI State
Saving and Restoring States
Multistep Interfaces
Streaming Values
Handling Loading State
Error Handling
Handling Authentication
Migrating from RSC to UI

Advanced

Advanced
Prompt Engineering
Stopping Streams
Backpressure
Caching
Multiple Streamables
Rate Limiting
Rendering UI with Language Models
Language Models as Routers
Multistep Interfaces
Sequential Generations
Vercel Deployment Guide
Secure URL Fetching

Reference

Reference

Reference › AI SDK Core

AI SDK Core
generateText
streamText
experimental_streamTextLowMemory
embed
embedMany
rerank
generateImage
experimental_streamTranscribe
experimental_streamTranslate
transcribe
generateSpeech
experimental_streamSpeech
experimental_generateVideo
experimental_decide
uploadFile
uploadSkill
Agent (Interface)
ToolLoopAgent
createAgentUIStream
createAgentUIStreamResponse
pipeAgentUIStreamToResponse
experimental_startBatch
tool
experimental_getBatchStatus
dynamicTool
experimental_getBatchResults
experimental_cancelBatch
createMCPClient
experimental_getRealtimeToolDefinitions
toolSearch
experimental_listBatches
MCP Apps
MCP Events
Experimental_StdioMCPTransport
jsonSchema
zodSchema
valibotSchema
Output
filterActiveTools
ModelMessage
UIMessage
validateUIMessages
safeValidateUIMessages
Experimental_SandboxSession
createProviderRegistry
customProvider
cosineSimilarity
wrapLanguageModel
wrapImageModel
LanguageModelV4Middleware
extractReasoningMiddleware
simulateStreamingMiddleware
defaultInstructionsMiddleware
defaultSettingsMiddleware
addToolInputExamplesMiddleware
extractJsonMiddleware
isStepCount
hasToolCall
isLoopFinished
simulateReadableStream
smoothStream
generateId
createIdGenerator
DefaultGeneratedFile

Reference › AI SDK UI

AI SDK UI
useChat
useCompletion
useObject
experimental_useRealtime
convertToModelMessages
pruneMessages
createUIMessageStream
createUIMessageStreamResponse
pipeUIMessageStreamToResponse
readUIMessageStream
InferUITools
InferUITool
experimental_MCPAppRenderer
DirectChatTransport
WebSocketChatTransport

Reference › AI SDK RSC

AI SDK RSC
streamUI
createAI
createStreamableUI
createStreamableValue
readStreamableValue
getAIState
getMutableAIState
useAIState
useActions
useUIState
useStreamableValue
render (Removed)

Reference › AI SDK Workflow

AI SDK Workflow
WorkflowAgent
WorkflowChatTransport
generateVideo

Reference › AI SDK Errors

AI SDK Errors
AI_APICallError
AI_DecisionRefusalError
AI_DecisionUnsupportedQuestionTypeError
AI_DownloadError
AI_EmptyResponseBodyError
AI_InvalidArgumentError
AI_InvalidDataContentError
AI_InvalidMessageRoleError
AI_InvalidPromptError
AI_InvalidResponseDataError
AI_InvalidToolApprovalError
AI_InvalidToolApprovalSignatureError
AI_InvalidToolInputError
AI_JSONParseError
AI_LoadAPIKeyError
AI_LoadSettingError
AI_MessageConversionError
AI_NoContentGeneratedError
AI_NoImageGeneratedError
AI_NoObjectGeneratedError
AI_NoOutputGeneratedError
AI_NoSpeechGeneratedError
AI_NoSuchModelError
AI_NoSuchProviderError
AI_NoSuchProviderReferenceError
AI_NoSuchToolError
AI_NoTranscriptGeneratedError
AI_NoTranslationGeneratedError
AI_NoVideoGeneratedError
AI_RetryError
AI_StreamProviderError
AI_TooManyEmbeddingValuesForCallError
AI_ToolCallNotFoundForApprovalError
ToolCallRepairError
ToolChoiceViolationError
AI_TypeValidationError
AI_UIMessageStreamError
AI_UnsupportedFunctionalityError

Reference › AI SDK TUI

AI SDK TUI
runAgentTUI

Migration Guides

Migration Guides
Versioning
Migrate AI SDK 6.x to 7.0
Migrate AI SDK 5.x to 6.0
Migrate Your Data to AI SDK 5.0
Migrate AI SDK 4.x to 5.0
Migrate AI SDK 4.1 to 4.2
Migrate AI SDK 4.0 to 4.1
Migrate AI SDK 3.4 to 4.0
Migrate AI SDK 3.3 to 3.4
Migrate AI SDK 3.2 to 3.3
Migrate AI SDK 3.1 to 3.2
Migrate AI SDK 3.0 to 3.1

Troubleshooting

Troubleshooting
Azure OpenAI Slow to Stream
Server Actions in Client Components
useChat/useCompletion stream output contains 0:... instead of text
Streamable UI Errors
Tool Invocation Missing Result Error
Streaming Not Working When Deployed
Streaming Not Working When Proxied
Getting Timeouts When Deploying on Vercel
Unclosed Streams
useChat Failed to Parse Stream
Server Action Plain Objects Error
useChat No Response
Custom headers, body, and credentials not working with useChat
TypeScript performance issues with Zod and AI SDK 5
useChat "An error occurred"
Repeated assistant messages in useChat
onEnd not called when stream is aborted
Tool calling with structured outputs
Abort and resumable streams
streamText fails silently
Streaming Status Shows But No Text Appears
Stale body values with useChat
Type Error with onToolCall
Unsupported model version error
Object generation failed with OpenAI
Missing Tool Results Error
Model is not assignable to type "LanguageModelV1"
TypeScript error "Cannot find namespace 'JSX'"
React error "Maximum update depth exceeded"
Jest: cannot find module '@ai-sdk/rsc'
High memory usage when processing many images

Cookbook › Guides

Guides
RAG Agent
Multi-Modal Agent
Slackbot Agent Guide
Natural Language Postgres
Get started with Computer Use
Add Skills to Your Agent
Build a Custom Memory Tool
Compact Agent Context
Get started with Gemini 3
Get started with Claude 4
OpenAI Responses API
Google Gemini Image Generation
Get started with Claude 3.7 Sonnet
Get started with Llama 3.1
Get started with GPT-5
Get started with OpenAI o1
Get started with OpenAI o3-mini
Get started with DeepSeek R1
Get started with DeepSeek V3.2

Cookbook › Next.js

Next.js
Generate Text
Generate Text with Chat Prompt
Generate Image with Chat Prompt
Caching Middleware
Stream Text
Stream Text with Chat Prompt
Stream Text with Image Prompt
Chat with PDFs
streamText Multi-Step Cookbook
Markdown Chatbot with Streamdown
Generate Object
Generate Object with File Prompt through Form Submission
Stream Object
Call Tools
Call Tools in Multiple Steps
Model Context Protocol (MCP) Tools
Share useChat State Across Components
Human-in-the-Loop with Next.js
Track Agent Token Usage
Send Custom Body from useChat
Streaming with Custom Format
Render Visual Interface in Chat

Cookbook › Node

Node
Generate Text
Retrieval Augmented Generation
Knowledge Base Agent
Generate Text with Chat Prompt
Generate Text with Image Prompt
Stream Text
Stream Text with Chat Prompt
Stream Text with Image Prompt
Stream Text with File Prompt
Generate Object
Generate Object with a Reasoning Model
Stream Object
Stream Object with Image Prompt
Record Token Usage After Streaming Object
Record Final Object after Streaming Object
Call Tools
Call Tools in Parallel
Call Tools with Image Prompt
Call Tools in Multiple Steps
Model Context Protocol (MCP) Tools
Manual Agent Loop
Web Search Agent
Model Context Protocol (MCP) Elicitation
Receive MCP Webhook Events
Embed Text
Embed Text in Batch
Intercepting Fetch Requests
Local Caching Middleware
Repair Malformed JSON with jsonrepair
Dynamic Prompt Caching

Cookbook › API Servers

API Servers
Node.js HTTP Server
Express
Hono
Fastify
Nest.js

Cookbook › React Server Components

React Server Components
Generate Text
Generate Text with Chat Prompt
Stream Text
Stream Text with Chat Prompt
Generate Object
Stream Object
Call Tools
Call Tools in Parallel
Save Messages To Database
Restore Messages From Database
Render Visual Interface in Chat
Stream Updates to Visual Interfaces
Record Token Usage after Streaming User Interfaces

Providers › AI SDK Providers

AI SDK Providers
AI Gateway
xAI Grok
OpenAI
Azure OpenAI
Anthropic
Open Responses
Claude Platform on AWS
Amazon Bedrock
Groq
Fal
AssemblyAI
GMI Cloud
TypeSafe
DeepInfra
Deepgram
Black Forest Labs
Gladia
Google
Hume
Google Vertex AI
Rev.ai
Baseten
Hugging Face
QuiverAI
Fish Audio
Mistral AI
Z.AI
Topaz Labs
HeyGen
Together.ai
Cohere
Fireworks
Voyage AI
DeepSeek
Moonshot AI
Alibaba
MiniMax
Cerebras
Replicate
Prodia
Perplexity
Luma
ByteDance
Kling AI
ElevenLabs
Cartesia

Providers › AI SDK Harnesses

AI SDK Harnesses
Claude Code
Codex
Pi
OpenCode
Deep Agents
Agent Client Protocol
Grok Build
Cline
Cursor
fx
GitHub Copilot

Providers › Observability Integrations

Observability Integrations
Arize AX
Axiom
Braintrust
Confident AI
Datadog Agent Observability
Helicone
Laminar
Langfuse
LangSmith
LangWatch
Latitude
Maxim
MLflow
Patronus
PostHog
Raindrop
Respan
Scorecard
Sentry
SigNoz
Traceloop
Weave

Providers › OpenAI Compatible Providers

OpenAI Compatible Providers
Writing a Custom Provider
LM Studio
NVIDIA NIM
ModelRush
Cheaper Inference
Clarifai
Heroku
NEAR AI Cloud
TopxAI

Providers › Community Providers

Community Providers
Writing a Custom Provider
A2A
ACP (Agent Client Protocol)
Aihubmix
AI/ML API
Anthropic Vertex
Automatic1111
Azure AI
Browser AI
Claude Code
Cloudflare AI Gateway
Cloudflare Workers AI
Codex CLI
Crosshatch
Dify
Firemoon
FriendliAI
Gemini CLI
Helicone
Inflection AI
Jina AI
LangDB
Letta
llama.cpp
LlamaGate
MCP Sampling AI Provider
Mem0
MiniMax
Mixedbread
Ollama
OpenCode
OpenRouter
Portkey
Qwen
React Native Apple
Requesty
Runpod
SambaNova
SAP AI Core
Sarvam
Soniox
Spark
Supermemory
Voyage AI
Zhipu AI (Z.AI)
vectorstores
Codex CLI (App Server)
Apertis
OLLM
Cencori
Hindsight
Nia
ZeroEntropy
Crusoe
Neon AI Gateway
QVAC
Interfaze
Telnyx
Flowise

Providers › Adapters

Adapters
LangChain
LlamaIndex

API Servers

Edit on GitHub

Adapted from ai-sdk.dev/cookbook/api-servers by Vercel, Inc., licensed under Apache-2.0. Changes were made: this page is re-rendered from the original's source.

PreviousDynamic Prompt Caching NextNode.js HTTP Server

Wide content