# API Reference ## Navigation - [AI SDK by Vercel](/v4/docs/introduction) - [AI SDK 5 Beta](/v4/docs/announcing-ai-sdk-5-beta) - [Foundations](/v4/docs/foundations) - [Overview](/v4/docs/foundations/overview) - [Providers and Models](/v4/docs/foundations/providers-and-models) - [Prompts](/v4/docs/foundations/prompts) - [Tools](/v4/docs/foundations/tools) - [Streaming](/v4/docs/foundations/streaming) - [Agents](/v4/docs/foundations/agents) - [Getting Started](/v4/docs/getting-started) - [Navigating the Library](/v4/docs/getting-started/navigating-the-library) - [Next.js App Router](/v4/docs/getting-started/nextjs-app-router) - [Next.js Pages Router](/v4/docs/getting-started/nextjs-pages-router) - [Svelte](/v4/docs/getting-started/svelte) - [Vue.js (Nuxt)](/v4/docs/getting-started/nuxt) - [Node.js](/v4/docs/getting-started/nodejs) - [Expo](/v4/docs/getting-started/expo) - [AI SDK Core](/v4/docs/ai-sdk-core) - [Overview](/v4/docs/ai-sdk-core/overview) - [Generating Text](/v4/docs/ai-sdk-core/generating-text) - [Generating Structured Data](/v4/docs/ai-sdk-core/generating-structured-data) - [Tool Calling](/v4/docs/ai-sdk-core/tools-and-tool-calling) - [Prompt Engineering](/v4/docs/ai-sdk-core/prompt-engineering) - [Settings](/v4/docs/ai-sdk-core/settings) - [Embeddings](/v4/docs/ai-sdk-core/embeddings) - [Image Generation](/v4/docs/ai-sdk-core/image-generation) - [Transcription](/v4/docs/ai-sdk-core/transcription) - [Speech](/v4/docs/ai-sdk-core/speech) - [Language Model Middleware](/v4/docs/ai-sdk-core/middleware) - [Provider & Model Management](/v4/docs/ai-sdk-core/provider-management) - [Error Handling](/v4/docs/ai-sdk-core/error-handling) - [Testing](/v4/docs/ai-sdk-core/testing) - [Telemetry](/v4/docs/ai-sdk-core/telemetry) - [AI SDK UI](/v4/docs/ai-sdk-ui) - [Overview](/v4/docs/ai-sdk-ui/overview) - [Chatbot](/v4/docs/ai-sdk-ui/chatbot) - [Chatbot Message Persistence](/v4/docs/ai-sdk-ui/chatbot-message-persistence) - [Chatbot Tool Usage](/v4/docs/ai-sdk-ui/chatbot-tool-usage) - [Generative User Interfaces](/v4/docs/ai-sdk-ui/generative-user-interfaces) - [Completion](/v4/docs/ai-sdk-ui/completion) - [Object Generation](/v4/docs/ai-sdk-ui/object-generation) - [OpenAI Assistants](/v4/docs/ai-sdk-ui/openai-assistants) - [Streaming Custom Data](/v4/docs/ai-sdk-ui/streaming-data) - [Error Handling](/v4/docs/ai-sdk-ui/error-handling) - [Smooth streaming japanese text](/v4/docs/ai-sdk-ui/smooth-stream-japanese) - [Smooth streaming chinese text](/v4/docs/ai-sdk-ui/smooth-stream-chinese) - [Stream Protocols](/v4/docs/ai-sdk-ui/stream-protocol) - [AI SDK RSC](/v4/docs/ai-sdk-rsc) - [Overview](/v4/docs/ai-sdk-rsc/overview) - [Streaming React Components](/v4/docs/ai-sdk-rsc/streaming-react-components) - [Managing Generative UI State](/v4/docs/ai-sdk-rsc/generative-ui-state) - [Saving and Restoring States](/v4/docs/ai-sdk-rsc/saving-and-restoring-states) - [Multistep Interfaces](/v4/docs/ai-sdk-rsc/multistep-interfaces) - [Streaming Values](/v4/docs/ai-sdk-rsc/streaming-values) - [Handling Loading State](/v4/docs/ai-sdk-rsc/loading-state) - [Error Handling](/v4/docs/ai-sdk-rsc/error-handling) - [Handling Authentication](/v4/docs/ai-sdk-rsc/authentication) - [Migrating from RSC to UI](/v4/docs/ai-sdk-rsc/migrating-to-ui) - [Advanced](/v4/docs/advanced) - [Prompt Engineering](/v4/docs/advanced/prompt-engineering) - [Stopping Streams](/v4/docs/advanced/stopping-streams) - [Backpressure](/v4/docs/advanced/backpressure) - [Caching](/v4/docs/advanced/caching) - [Multiple Streamables](/v4/docs/advanced/multiple-streamables) - [Rate Limiting](/v4/docs/advanced/rate-limiting) - [Rendering UI with Language Models](/v4/docs/advanced/rendering-ui-with-language-models) - [Language Models as Routers](/v4/docs/advanced/model-as-router) - [Multistep Interfaces](/v4/docs/advanced/multistep-interfaces) - [Sequential Generations](/v4/docs/advanced/sequential-generations) - [Vercel Deployment Guide](/v4/docs/advanced/vercel-deployment-guide) - [Reference](/v4/docs/reference) - [AI SDK Core](/v4/docs/reference/ai-sdk-core) - [generateText](/v4/docs/reference/ai-sdk-core/generate-text) - [streamText](/v4/docs/reference/ai-sdk-core/stream-text) - [generateObject](/v4/docs/reference/ai-sdk-core/generate-object) - [streamObject](/v4/docs/reference/ai-sdk-core/stream-object) - [embed](/v4/docs/reference/ai-sdk-core/embed) - [embedMany](/v4/docs/reference/ai-sdk-core/embed-many) - [generateImage](/v4/docs/reference/ai-sdk-core/generate-image) - [transcribe](/v4/docs/reference/ai-sdk-core/transcribe) - [generateSpeech](/v4/docs/reference/ai-sdk-core/generate-speech) - [tool](/v4/docs/reference/ai-sdk-core/tool) - [experimental_createMCPClient](/v4/docs/reference/ai-sdk-core/create-mcp-client) - [Experimental_StdioMCPTransport](/v4/docs/reference/ai-sdk-core/mcp-stdio-transport) - [jsonSchema](/v4/docs/reference/ai-sdk-core/json-schema) - [zodSchema](/v4/docs/reference/ai-sdk-core/zod-schema) - [valibotSchema](/v4/docs/reference/ai-sdk-core/valibot-schema) - [CoreMessage](/v4/docs/reference/ai-sdk-core/core-message) - [createProviderRegistry](/v4/docs/reference/ai-sdk-core/provider-registry) - [customProvider](/v4/docs/reference/ai-sdk-core/custom-provider) - [cosineSimilarity](/v4/docs/reference/ai-sdk-core/cosine-similarity) - [wrapLanguageModel](/v4/docs/reference/ai-sdk-core/wrap-language-model) - [LanguageModelV1Middleware](/v4/docs/reference/ai-sdk-core/language-model-v1-middleware) - [extractReasoningMiddleware](/v4/docs/reference/ai-sdk-core/extract-reasoning-middleware) - [simulateStreamingMiddleware](/v4/docs/reference/ai-sdk-core/simulate-streaming-middleware) - [defaultSettingsMiddleware](/v4/docs/reference/ai-sdk-core/default-settings-middleware) - [simulateReadableStream](/v4/docs/reference/ai-sdk-core/simulate-readable-stream) - [smoothStream](/v4/docs/reference/ai-sdk-core/smooth-stream) - [generateId](/v4/docs/reference/ai-sdk-core/generate-id) - [createIdGenerator](/v4/docs/reference/ai-sdk-core/create-id-generator) - [AI SDK UI](/v4/docs/reference/ai-sdk-ui) - [useChat](/v4/docs/reference/ai-sdk-ui/use-chat) - [useCompletion](/v4/docs/reference/ai-sdk-ui/use-completion) - [useObject](/v4/docs/reference/ai-sdk-ui/use-object) - [useAssistant](/v4/docs/reference/ai-sdk-ui/use-assistant) - [AssistantResponse](/v4/docs/reference/ai-sdk-ui/assistant-response) - [convertToCoreMessages](/v4/docs/reference/ai-sdk-ui/convert-to-core-messages) - [appendResponseMessages](/v4/docs/reference/ai-sdk-ui/append-response-messages) - [appendClientMessage](/v4/docs/reference/ai-sdk-ui/append-client-message) - [createDataStream](/v4/docs/reference/ai-sdk-ui/create-data-stream) - [createDataStreamResponse](/v4/docs/reference/ai-sdk-ui/create-data-stream-response) - [pipeDataStreamToResponse](/v4/docs/reference/ai-sdk-ui/pipe-data-stream-to-response) - [StreamData](/v4/docs/reference/ai-sdk-ui/stream-data) - [AI SDK RSC](/v4/docs/reference/ai-sdk-rsc) - [streamUI](/v4/docs/reference/ai-sdk-rsc/stream-ui) - [createAI](/v4/docs/reference/ai-sdk-rsc/create-ai) - [createStreamableUI](/v4/docs/reference/ai-sdk-rsc/create-streamable-ui) - [createStreamableValue](/v4/docs/reference/ai-sdk-rsc/create-streamable-value) - [readStreamableValue](/v4/docs/reference/ai-sdk-rsc/read-streamable-value) - [getAIState](/v4/docs/reference/ai-sdk-rsc/get-ai-state) - [getMutableAIState](/v4/docs/reference/ai-sdk-rsc/get-mutable-ai-state) - [useAIState](/v4/docs/reference/ai-sdk-rsc/use-ai-state) - [useActions](/v4/docs/reference/ai-sdk-rsc/use-actions) - [useUIState](/v4/docs/reference/ai-sdk-rsc/use-ui-state) - [useStreamableValue](/v4/docs/reference/ai-sdk-rsc/use-streamable-value) - [render (Removed)](/v4/docs/reference/ai-sdk-rsc/render) - [Stream Helpers](/v4/docs/reference/stream-helpers) - [AIStream](/v4/docs/reference/stream-helpers/ai-stream) - [StreamingTextResponse](/v4/docs/reference/stream-helpers/streaming-text-response) - [streamToResponse](/v4/docs/reference/stream-helpers/stream-to-response) - [OpenAIStream](/v4/docs/reference/stream-helpers/openai-stream) - [AnthropicStream](/v4/docs/reference/stream-helpers/anthropic-stream) - [AWSBedrockStream](/v4/docs/reference/stream-helpers/aws-bedrock-stream) - [AWSBedrockAnthropicStream](/v4/docs/reference/stream-helpers/aws-bedrock-anthropic-stream) - [AWSBedrockAnthropicMessagesStream](/v4/docs/reference/stream-helpers/aws-bedrock-messages-stream) - [AWSBedrockCohereStream](/v4/docs/reference/stream-helpers/aws-bedrock-cohere-stream) - [AWSBedrockLlama2Stream](/v4/docs/reference/stream-helpers/aws-bedrock-llama-2-stream) - [CohereStream](/v4/docs/reference/stream-helpers/cohere-stream) - [GoogleGenerativeAIStream](/v4/docs/reference/stream-helpers/google-generative-ai-stream) - [HuggingFaceStream](/v4/docs/reference/stream-helpers/hugging-face-stream) - [LangChainAdapter](/v4/docs/reference/stream-helpers/langchain-adapter) - [LangChainStream](/v4/docs/reference/stream-helpers/langchain-stream) - [LlamaIndexAdapter](/v4/docs/reference/stream-helpers/llamaindex-adapter) - [MistralStream](/v4/docs/reference/stream-helpers/mistral-stream) - [ReplicateStream](/v4/docs/reference/stream-helpers/replicate-stream) - [InkeepStream](/v4/docs/reference/stream-helpers/inkeep-stream) - [AI SDK Errors](/v4/docs/reference/ai-sdk-errors) - [AI_APICallError](/v4/docs/reference/ai-sdk-errors/ai-api-call-error) - [AI_DownloadError](/v4/docs/reference/ai-sdk-errors/ai-download-error) - [AI_EmptyResponseBodyError](/v4/docs/reference/ai-sdk-errors/ai-empty-response-body-error) - [AI_InvalidArgumentError](/v4/docs/reference/ai-sdk-errors/ai-invalid-argument-error) - [AI_InvalidDataContentError](/v4/docs/reference/ai-sdk-errors/ai-invalid-data-content-error) - [AI_InvalidDataContent](/v4/docs/reference/ai-sdk-errors/ai-invalid-data-content) - [AI_InvalidMessageRoleError](/v4/docs/reference/ai-sdk-errors/ai-invalid-message-role-error) - [AI_InvalidPromptError](/v4/docs/reference/ai-sdk-errors/ai-invalid-prompt-error) - [AI_InvalidResponseDataError](/v4/docs/reference/ai-sdk-errors/ai-invalid-response-data-error) - [AI_InvalidToolArgumentsError](/v4/docs/reference/ai-sdk-errors/ai-invalid-tool-arguments-error) - [AI_JSONParseError](/v4/docs/reference/ai-sdk-errors/ai-json-parse-error) - [AI_LoadAPIKeyError](/v4/docs/reference/ai-sdk-errors/ai-load-api-key-error) - [AI_LoadSettingError](/v4/docs/reference/ai-sdk-errors/ai-load-setting-error) - [AI_MessageConversionError](/v4/docs/reference/ai-sdk-errors/ai-message-conversion-error) - [AI_NoAudioGeneratedError](/v4/docs/reference/ai-sdk-errors/ai-no-audio-generated-error) - [AI_NoContentGeneratedError](/v4/docs/reference/ai-sdk-errors/ai-no-content-generated-error) - [AI_NoImageGeneratedError](/v4/docs/reference/ai-sdk-errors/ai-no-image-generated-error) - [AI_NoObjectGeneratedError](/v4/docs/reference/ai-sdk-errors/ai-no-object-generated-error) - [AI_NoOutputSpecifiedError](/v4/docs/reference/ai-sdk-errors/ai-no-output-specified-error) - [AI_NoSuchModelError](/v4/docs/reference/ai-sdk-errors/ai-no-such-model-error) - [AI_NoSuchProviderError](/v4/docs/reference/ai-sdk-errors/ai-no-such-provider-error) - [AI_NoSuchToolError](/v4/docs/reference/ai-sdk-errors/ai-no-such-tool-error) - [AI_NoTranscriptGeneratedError](/v4/docs/reference/ai-sdk-errors/ai-no-transcript-generated-error) - [AI_RetryError](/v4/docs/reference/ai-sdk-errors/ai-retry-error) - [AI_TooManyEmbeddingValuesForCallError](/v4/docs/reference/ai-sdk-errors/ai-too-many-embedding-values-for-call-error) - [ToolCallRepairError](/v4/docs/reference/ai-sdk-errors/ai-tool-call-repair-error) - [AI_ToolExecutionError](/v4/docs/reference/ai-sdk-errors/ai-tool-execution-error) - [AI_TypeValidationError](/v4/docs/reference/ai-sdk-errors/ai-type-validation-error) - [AI_UnsupportedFunctionalityError](/v4/docs/reference/ai-sdk-errors/ai-unsupported-functionality-error) - [Migration Guides](/v4/docs/migration-guides) - [Versioning](/v4/docs/migration-guides/versioning) - [Migrate AI SDK 4.1 to 4.2](/v4/docs/migration-guides/migration-guide-4-2) - [Migrate AI SDK 4.0 to 4.1](/v4/docs/migration-guides/migration-guide-4-1) - [Migrate AI SDK 3.4 to 4.0](/v4/docs/migration-guides/migration-guide-4-0) - [Migrate AI SDK 3.3 to 3.4](/v4/docs/migration-guides/migration-guide-3-4) - [Migrate AI SDK 3.2 to 3.3](/v4/docs/migration-guides/migration-guide-3-3) - [Migrate AI SDK 3.1 to 3.2](/v4/docs/migration-guides/migration-guide-3-2) - [Migrate AI SDK 3.0 to 3.1](/v4/docs/migration-guides/migration-guide-3-1) - [Troubleshooting](/v4/docs/troubleshooting) - [Azure OpenAI Slow to Stream](/v4/docs/troubleshooting/azure-stream-slow) - [Client-Side Function Calls Not Invoked](/v4/docs/troubleshooting/client-side-function-calls-not-invoked) - [Server Actions in Client Components](/v4/docs/troubleshooting/server-actions-in-client-components) - [useChat/useCompletion stream output contains 0:... instead of text](/v4/docs/troubleshooting/strange-stream-output) - [Streamable UI Errors](/v4/docs/troubleshooting/streamable-ui-errors) - [Tool Invocation Missing Result Error](/v4/docs/troubleshooting/tool-invocation-missing-result) - [Streaming Not Working When Deployed](/v4/docs/troubleshooting/streaming-not-working-when-deployed) - [Streaming Not Working When Proxied](/v4/docs/troubleshooting/streaming-not-working-when-proxied) - [Getting Timeouts When Deploying on Vercel](/v4/docs/troubleshooting/timeout-on-vercel) - [Unclosed Streams](/v4/docs/troubleshooting/unclosed-streams) - [useChat Failed to Parse Stream](/v4/docs/troubleshooting/use-chat-failed-to-parse-stream) - [Server Action Plain Objects Error](/v4/docs/troubleshooting/client-stream-error) - [useChat No Response with maxSteps](/v4/docs/troubleshooting/use-chat-tools-no-response) - [useChat "An error occurred"](/v4/docs/troubleshooting/use-chat-an-error-occurred) - [streamText fails silently](/v4/docs/troubleshooting/stream-text-not-working) - [NaN token counts when using streamText with OpenAI models](/v4/docs/troubleshooting/nan-token-counts-openai-streaming) - [Model is not assignable to type "LanguageModelV1"](/v4/docs/troubleshooting/model-is-not-assignable-to-type) - [TypeScript error "Cannot find namespace 'JSX'"](/v4/docs/troubleshooting/typescript-cannot-find-namespace-jsx) - [React error "Maximum update depth exceeded"](/v4/docs/troubleshooting/react-maximum-update-depth-exceeded) - [Jest: cannot find module 'ai/rsc'](/v4/docs/troubleshooting/jest-cannot-find-module-ai-rsc) - [Schema must be JSON Schema of type object error](/v4/docs/troubleshooting/zod-v4-json-schema-type-error) [Full Sitemap](/sitemap.md)