vercel/ai

Foundations

Overview

Providers and Models

Prompts

Tools

Streaming

Foundations

Getting Started

Navigating the Library

Next.js App Router Quickstart

Next.js Pages Router Quickstart

Svelte

Nuxt Quickstart

Node.js Quickstart

Expo Quickstart

Getting Started

Agents

Agents Overview

Building Agents

Workflow Patterns

Loop Control

Configuring Call Options

Agents

Core Functions & Features

Overview

Generating Text

Generating Structured Data

Tool Calling

Model Context Protocol (MCP)

Prompt Engineering

Settings

Embeddings

Reranking

Image Generation

Transcription

Speech

Language Model Middleware

Provider & Model Management

Error Handling

Testing

Telemetry

AI SDK Core

UI Toolkit

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 UI

React Server Components

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

RSC

Advanced Patterns

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

Advanced

API Reference

Core API Reference

generateText

streamText

generateObject

streamObject

embed

embedMany

rerank

generateImage

transcribe

generateSpeech

Agent Interface

ToolLoopAgent

createAgentUIStream

createAgentUIStreamResponse

pipeAgentUIStreamToResponse

tool

dynamicTool

experimental_createMCPClient

Experimental_StdioMCPTransport

jsonSchema

zodSchema

valibotSchema

ModelMessage

UIMessage

validateUIMessages

safeValidateUIMessages

createProviderRegistry

customProvider

cosineSimilarity

wrapLanguageModel

LanguageModelV3Middleware

extractReasoningMiddleware

simulateStreamingMiddleware

defaultSettingsMiddleware

stepCountIs

hasToolCall

simulateReadableStream

smoothStream

generateId

createIdGenerator

AI SDK Core

UI Hooks & Utilities

useChat

useCompletion

useObject

convertToModelMessages

pruneMessages

createUIMessageStream

createUIMessageStreamResponse

pipeUIMessageStreamToResponse

readUIMessageStream

InferUITools

InferUITool

AI SDK UI

RSC API Reference

streamUI

createAI

createStreamableUI

createStreamableValue

readStreamableValue

getAIState

getMutableAIState

useAIState

useActions

useUIState

useStreamableValue

render (Removed)

AI SDK RSC

Deprecated Stream Helpers

AIStream

StreamingTextResponse

streamToResponse

OpenAIStream

AnthropicStream

AWSBedrockStream

AWSBedrockAnthropicStream

AWSBedrockAnthropicMessagesStream

AWSBedrockCohereStream

AWSBedrockLlama2Stream

CohereStream

GoogleGenerativeAIStream

HuggingFaceStream

LangChain Adapter

LlamaIndex Adapter

MistralStream

ReplicateStream

InkeepStream

Stream Helpers

Error Reference

AI_APICallError

AI_DownloadError

AI_EmptyResponseBodyError

InvalidArgumentError

InvalidDataContentError

AI_InvalidDataContent

InvalidMessageRoleError

AI_InvalidPromptError

InvalidResponseDataError

InvalidToolInputError

AI_JSONParseError

AI_LoadAPIKeyError

AI_LoadSettingError

MessageConversionError

NoContentGeneratedError

AI_NoImageGeneratedError

AI_NoObjectGeneratedError

NoSpeechGeneratedError

NoSuchModelError

AI_NoSuchProviderError

AI_NoSuchToolError

NoTranscriptGeneratedError

AI_RetryError

TooManyEmbeddingValuesForCallError

ToolCallRepairError

TypeValidationError

AI_UnsupportedFunctionalityError

AI SDK Errors

Reference

Migration Guides

Versioning

Migrate Data to AI SDK 5.0

Migrate AI SDK 4.0 to 5.0

Migrate AI SDK 4.1 to 4.2

Migrate AI SDK 5.0 to 6.0 Beta

Migrate 4.0 to 4.1

Migrate AI SDK 3.4 to 4.0

Migrate 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

Migration Guides

Troubleshooting

Azure OpenAI Slow to Stream

Client-Side Function Calls Not Invoked

Server Actions in Client Components

Stream output contains protocol markers 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

useChat "An error occurred" Troubleshooting

Repeated assistant messages in useChat

onFinish not called when stream is aborted

Tool calling with structured outputs

Abort breaks 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

Model is not assignable to type LanguageModelV1

TypeScript error "Cannot find namespace 'JSX'"

React Maximum Update Depth Exceeded

Jest: cannot find module '@ai-sdk/rsc'

Troubleshooting

AI SDK by Vercel

AI SDK 6 Beta

Home / vercel/ai / api_reference/ error_reference/ ai_loadapikeyerror

Command Palette

Search for a command to run

AI_LoadAPIKeyError

✓ Relevant

AI_LoadAPIKeyError: error thrown on failed API key loading; detect via LoadAPIKeyError.isInstance()

Made by Alexey with ❤️

human-index