ai 7.0.122 → 7.0.124

package/docs/04-ai-sdk-ui/03-chatbot-resume-streams.mdx

@@ -218,7 +218,7 @@ The diagram above shows the complete lifecycle of a resumable stream:
 2. **Stream tracking**: Your persistence layer saves the `activeStreamId` in the chat data
 3. **Client reconnection**: When the client reconnects (page reload), the `resume` option triggers a GET request to `/api/chat/[id]/stream`
 4. **Stream recovery**: The GET handler checks for an `activeStreamId` and uses `resumeExistingStream` to reconnect. If no active stream exists, it returns a 204 (No Content) response
-5. **Completion cleanup**: When the stream finishes, the `onFinish` callback clears the `activeStreamId` by setting it to `null`
+5. **Completion cleanup**: When the stream finishes, the `onEnd` callback clears the `activeStreamId` by setting it to `null`
 
 ## Customize the resume endpoint
 
@@ -310,7 +310,7 @@ export function Chat({
     const assistantMessage =
       lastMessage?.role === 'assistant' ? lastMessage : undefined;
 
-    void fetch(`/api/chat/${chatData.id}/stop`, {
+    void fetch(`/api/chat/${encodeURIComponent(chatData.id)}/stop`, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify(

package/docs/04-ai-sdk-ui/03-chatbot-tool-usage.mdx

@@ -228,9 +228,7 @@ export default function Chat() {
                     return <div key={callId}>Approval response received.</div>;
                   case 'output-available':
                     return (
-                      <div key={callId}>
-                        Location access allowed: {part.output}
-                      </div>
+                      <div key={callId}>Confirmation result: {part.output}</div>
                     );
                   case 'output-error':
                     return <div key={callId}>Error: {part.errorText}</div>;
@@ -356,22 +354,22 @@ export default function Chat() {
         return;
       }
 
-      if (toolCall.toolName === 'getWeatherInformation') {
+      if (toolCall.toolName === 'getLocation') {
         try {
-          const weather = await getWeatherInformation(toolCall.input);
+          const location = await getLocation();
 
           // No await - avoids potential deadlocks
           addToolOutput({
-            tool: 'getWeatherInformation',
+            tool: 'getLocation',
             toolCallId: toolCall.toolCallId,
-            output: weather,
+            output: location,
           });
         } catch (err) {
           addToolOutput({
-            tool: 'getWeatherInformation',
+            tool: 'getLocation',
             toolCallId: toolCall.toolCallId,
             state: 'output-error',
-            errorText: 'Unable to get the weather information',
+            errorText: 'Unable to get the user location',
           });
         }
       }

package/docs/04-ai-sdk-ui/05-completion.mdx

@@ -184,7 +184,7 @@ const { messages, input, handleInputChange, handleSubmit } = useCompletion({
 });
 ```
 
-In this example, the `useCompletion` hook sends a POST request to the `/api/completion` endpoint with the specified headers, additional body fields, and credentials for that fetch request. On your server side, you can handle the request with these additional information.
+In this example, the `useCompletion` hook sends a POST request to the `/api/custom-completion` endpoint with the specified headers, additional body fields, and credentials for that fetch request. On your server side, you can handle the request with these additional information.
 
 You can provide a type for the additional body fields. The type applies to
 both the body configured on the hook and the body passed to `complete`:

package/docs/04-ai-sdk-ui/50-stream-protocol.mdx

@@ -21,8 +21,8 @@ A text stream contains chunks in plain text, that are streamed to the frontend.
 Each chunk is then appended together to form a full text response.
 
 Text streams are supported by `useChat`, `useCompletion`, and `useObject`.
-When you use `useChat` or `useCompletion`, you need to enable text streaming
-by setting the `streamProtocol` options to `text`.
+To enable text streaming, use `TextStreamChatTransport` with `useChat`, or set
+the `streamProtocol` option to `text` with `useCompletion`.
 
 You can generate text streams with `streamText` in the backend.
 Pass the result's `stream` to `toTextStream` and return it with

package/docs/05-ai-sdk-rsc/03-generative-ui-state.mdx

@@ -236,17 +236,18 @@ export default function Page() {
   const handleSubmit = async event => {
     event.preventDefault();
 
-    setMessages([
-      ...messages,
-      { id: Date.now(), role: 'user', display: event.target.message.value },
+    setMessages(currentMessages => [
+      ...currentMessages,
+      {
+        id: Date.now().toString(),
+        role: 'user',
+        display: event.target.message.value,
+      },
     ]);
 
     const response = await sendMessage(event.target.message.value);
 
-    setMessages([
-      ...messages,
-      { id: Date.now(), role: 'assistant', display: response },
-    ]);
+    setMessages(currentMessages => [...currentMessages, response]);
   };
 
   return (

package/docs/05-ai-sdk-rsc/06-loading-state.mdx

@@ -143,7 +143,7 @@ export async function generateResponse(prompt: string) {
 
 ### Client
 
-```tsx filename='app/page.tsx' highlight="22,30-34"
+```tsx filename='app/page.tsx' highlight="22,34-42"
 'use client';
 
 import { useState } from 'react';
@@ -169,15 +169,24 @@ export default function Home() {
 
           let textContent = '';
 
-          for await (const responseDelta of readStreamableValue(response)) {
-            textContent = `${textContent}${responseDelta}`;
-            setGeneration(textContent);
-          }
-          for await (const loadingDelta of readStreamableValue(loadingState)) {
-            if (loadingDelta) {
-              setLoading(loadingDelta.loading);
-            }
-          }
+          // read both streamable values concurrently
+          await Promise.all([
+            (async () => {
+              for await (const responseDelta of readStreamableValue(response)) {
+                textContent = `${textContent}${responseDelta}`;
+                setGeneration(textContent);
+              }
+            })(),
+            (async () => {
+              for await (const loadingDelta of readStreamableValue(
+                loadingState,
+              )) {
+                if (loadingDelta) {
+                  setLoading(loadingDelta.loading);
+                }
+              }
+            })(),
+          ]);
           setInput('');
           setLoading(false);
         }}

package/docs/05-ai-sdk-rsc/08-error-handling.mdx

@@ -40,6 +40,8 @@ export async function getStreamedUI() {
 With this method, you can catch any error with the stream, and return relevant UI. On the client, you can also use a [React Error Boundary](https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary) to wrap the streamed component and catch any additional errors.
 
 ```tsx filename='app/page.tsx'
+'use client';
+
 import { getStreamedUI } from '@/actions';
 import { useState } from 'react';
 import { ErrorBoundary } from './ErrorBoundary';

package/docs/05-ai-sdk-rsc/10-migrating-to-ui.mdx

@@ -82,7 +82,8 @@ export default function Page() {
       {messages.map(message => message)}
 
       <form
-        onSubmit={async () => {
+        onSubmit={async event => {
+          event.preventDefault();
           const response: ReactNode = await sendMessage(input);
           setMessages(msgs => [...msgs, response]);
         }}
@@ -642,9 +643,9 @@ export async function generateSampleNotifications() {
     for await (const partialObject of partialOutputStream) {
       stream.update(partialObject);
     }
-  })();
 
-  stream.done();
+    stream.done();
+  })();
 
   return { partialNotificationsStream: stream.value };
 }

package/docs/06-advanced/02-stopping-streams.mdx

@@ -120,12 +120,12 @@ const result = streamText({
   model: __MODEL__,
   prompt: 'Write a long story...',
   abortSignal: controller.signal,
-  onAbort: ({ steps }) => {
+  onAbort: async ({ steps }) => {
     // Called when stream is aborted - persist partial results
     await savePartialResults(steps);
     await logAbortEvent(steps.length);
   },
-  onEnd: ({ steps, totalUsage }) => {
+  onEnd: async ({ steps, totalUsage }) => {
     // Called when stream completes normally
     await saveFinalResults(steps, totalUsage);
   },

package/docs/06-advanced/04-caching.mdx

@@ -133,9 +133,9 @@ Here's an example of how you can use [Upstash Redis](https://upstash.com/redis)
 ```tsx filename="app/api/chat/route.ts"
 import {
   convertToModelMessages,
-  createUIMessageStreamResponse,
+  createTextStreamResponse,
   streamText,
-  toUIMessageStream,
+  toTextStream,
   UIMessage,
 } from 'ai';
 __PROVIDER_IMPORT__;
@@ -175,9 +175,13 @@ export async function POST(req: Request) {
     },
   });
 
-  // Respond with the stream
-  return createUIMessageStreamResponse({
-    stream: toUIMessageStream({ stream: result.stream }),
+  // Respond with a text stream, matching the cached plain text response
+  return createTextStreamResponse({
+    stream: toTextStream({ stream: result.stream }),
   });
 }
 ```
+
+Both the cached and the fresh responses use the
+[text stream protocol](/docs/ai-sdk-ui/stream-protocol#text-stream-protocol),
+so use `TextStreamChatTransport` when calling this route with `useChat`.

package/docs/06-advanced/05-multiple-streamables.mdx

@@ -45,7 +45,7 @@ The client side code is similar to the previous example, but the [tool call](/do
 You can stream UI components within other UI components. This allows you to create complex UIs that are built up from smaller, reusable components. In the example below, we pass a `historyChart` streamable as a prop to a `StockCard` component. The StockCard can render the `historyChart` streamable, and it will automatically update as the server responds with new data.
 
 ```tsx file='app/actions.tsx'
-async function getStockHistoryChart({ symbol: string }) {
+async function getStockHistoryChart({ symbol }: { symbol: string }) {
   'use server';
 
   const ui = createStreamableUI(<Spinner />);

package/docs/06-advanced/07-rendering-ui-with-language-models.mdx

@@ -48,7 +48,7 @@ const text = generateText({
       }),
       execute: async ({ city, unit }) => {
         const weather = getWeather({ city, unit });
-        const { temperature, unit, description, forecast } = weather;
+        const { temperature, description, forecast } = weather;
 
         return {
           temperature,
@@ -158,14 +158,14 @@ The **AI SDK RSC (`@ai-sdk/rsc`)** takes advantage of RSCs to solve the problem
 Rather than conditionally rendering user interfaces on the client based on the data returned by the language model, you can directly stream them from the server during a model generation.
 
 ```tsx highlight="3,22-31,38" filename="app/action.ts"
-import { createStreamableUI } from '@ai-sdk/rsc'
+import { createStreamableUI } from '@ai-sdk/rsc';
 
 const uiStream = createStreamableUI();
 
 const text = generateText({
   model: __MODEL__,
-  instructions: 'you are a friendly assistant'
-  prompt: 'what is the weather in SF?'
+  instructions: 'you are a friendly assistant',
+  prompt: 'what is the weather in SF?',
   tools: {
     getWeather: {
       description: 'Get the weather for a location',
@@ -173,30 +173,30 @@ const text = generateText({
         city: z.string().describe('The city to get the weather for'),
         unit: z
           .enum(['C', 'F'])
-          .describe('The unit to display the temperature in')
+          .describe('The unit to display the temperature in'),
       }),
       execute: async ({ city, unit }) => {
-        const weather = getWeather({ city, unit })
-        const { temperature, unit, description, forecast } = weather
+        const weather = getWeather({ city, unit });
+        const { temperature, description, forecast } = weather;
 
         uiStream.done(
           <WeatherCard
             weather={{
               temperature: 47,
               unit: 'F',
-              description: 'sunny'
+              description: 'sunny',
               forecast,
             }}
-          />
-        )
-      }
-    }
-  }
-})
+          />,
+        );
+      },
+    },
+  },
+});
 
 return {
-  display: uiStream.value
-}
+  display: uiStream.value,
+};
 ```
 
 The [`createStreamableUI`](/docs/reference/ai-sdk-rsc/create-streamable-ui) function belongs to the `@ai-sdk/rsc` module and creates a stream that can send React components to the client.

package/docs/06-advanced/09-multistep-interfaces.mdx

@@ -84,7 +84,7 @@ Tool: bookFlight("BA123", "12th December", ["John Doe", "Jane Doe"])
 Model: Your flight has been booked!
 ```
 
-In the last tool call, the `bookFlight` tool does not include passenger details as it is not available in the application context. As a result, it requests the user to provide the passenger details before proceeding with the booking.
+Before the last tool call, the passenger details needed by the `bookFlight` tool are not available in the application context. As a result, the model asks the user to provide the passenger details before proceeding with the booking.
 
 Looking up passenger information could've been another tool that the model could've called before calling the `bookFlight` tool assuming that the user is logged into the application. This way, the model does not have to ask the user for the passenger details and can proceed with the booking.
 

package/docs/07-reference/01-ai-sdk-core/01-generate-text.mdx

@@ -278,7 +278,7 @@ To see `generateText` in action, check out [these examples](#examples).
             {
               name: 'role',
               type: "'tool'",
-              description: 'The role for the assistant message.',
+              description: 'The role for the tool message.',
             },
             {
               name: 'content',
@@ -476,7 +476,7 @@ To see `generateText` in action, check out [these examples](#examples).
     },
     {
       name: 'timeout',
-      type: 'number | { totalMs?: number; stepMs?: number; toolMs?: number; tools?: { [toolName]Ms?: number } }',
+      type: 'number | { totalMs?: number; stepMs?: number; toolMs?: number; tools?: Partial<Record<`${toolName}Ms`, number>> }',
       isOptional: true,
       description:
         'Timeout in milliseconds. Can be specified as a number or as an object with totalMs, stepMs, toolMs, and/or tools properties. totalMs sets the total timeout for the entire call. stepMs sets the timeout for each individual step (LLM call). toolMs sets the default timeout for all tool executions. tools sets per-tool timeout overrides using the pattern {toolName}Ms (e.g. weatherMs, slowApiMs) that take precedence over toolMs - tool names are type-checked for autocomplete. If a tool takes longer than its timeout, it aborts and returns a tool-error so the model can respond or retry. Can be used alongside abortSignal.',
@@ -1199,9 +1199,9 @@ To see `generateText` in action, check out [these examples](#examples).
             },
             {
               name: 'timeout',
-              type: 'number | { totalMs?: number; stepMs?: number; chunkMs?: number } | undefined',
+              type: 'number | { totalMs?: number; stepMs?: number; firstChunkMs?: number; chunkMs?: number; toolMs?: number; tools?: Partial<Record<`${toolName}Ms`, number>> } | undefined',
               description:
-                'Timeout configuration for the generation. Can be a number (milliseconds) or an object with totalMs, stepMs, chunkMs.',
+                'Timeout configuration for the generation. Can be a number (milliseconds) or an object with totalMs, stepMs, firstChunkMs (streaming only), chunkMs, toolMs, and per-tool overrides via tools.',
             },
             {
               name: 'headers',

package/docs/07-reference/01-ai-sdk-core/02-stream-text.mdx

@@ -279,7 +279,7 @@ To see `streamText` in action, check out [these examples](#examples).
             {
               name: 'role',
               type: "'tool'",
-              description: 'The role for the assistant message.',
+              description: 'The role for the tool message.',
             },
             {
               name: 'content',
@@ -484,7 +484,7 @@ To see `streamText` in action, check out [these examples](#examples).
     },
     {
       name: 'timeout',
-      type: 'number | { totalMs?: number; stepMs?: number; firstChunkMs?: number; chunkMs?: number; toolMs?: number; tools?: { [toolName]Ms?: number } }',
+      type: 'number | { totalMs?: number; stepMs?: number; firstChunkMs?: number; chunkMs?: number; toolMs?: number; tools?: Partial<Record<`${toolName}Ms`, number>> }',
       isOptional: true,
       description:
         'Timeout in milliseconds. Can be specified as a number or as an object with totalMs, stepMs, firstChunkMs, chunkMs, toolMs, and/or tools properties. totalMs sets the total timeout for the entire call. stepMs sets the timeout for each individual step (LLM call). firstChunkMs sets the timeout until the first content-bearing output in each step; metadata, stream starts, empty deltas, raw chunks, and transport activity do not satisfy it. chunkMs sets the timeout between content-bearing output chunks after output has started; non-content chunks do not reset it. toolMs sets the default timeout for all tool executions. tools sets per-tool timeout overrides using the pattern {toolName}Ms (e.g. weatherMs, slowApiMs) that take precedence over toolMs - tool names are type-checked for autocomplete. If a tool takes longer than its timeout, it aborts and returns a tool-error so the model can respond or retry. Can be used alongside abortSignal.',
@@ -2213,9 +2213,9 @@ To see `streamText` in action, check out [these examples](#examples).
             },
             {
               name: 'timeout',
-              type: 'number | { totalMs?: number; stepMs?: number; chunkMs?: number } | undefined',
+              type: 'number | { totalMs?: number; stepMs?: number; firstChunkMs?: number; chunkMs?: number; toolMs?: number; tools?: Partial<Record<`${toolName}Ms`, number>> } | undefined',
               description:
-                'Timeout configuration for the generation. Can be a number (milliseconds) or an object with totalMs, stepMs, chunkMs.',
+                'Timeout configuration for the generation. Can be a number (milliseconds) or an object with totalMs, stepMs, firstChunkMs (streaming only), chunkMs, toolMs, and per-tool overrides via tools.',
             },
             {
               name: 'headers',

package/docs/07-reference/01-ai-sdk-core/11-stream-transcribe.mdx

@@ -88,6 +88,13 @@ console.log(await result.text);
       description:
         'When true, the provider includes raw provider chunks in the stream as `raw` parts.',
     },
+    {
+      name: 'telemetry',
+      type: 'TelemetryOptions',
+      isOptional: true,
+      description:
+        'Telemetry configuration. Experimental lifecycle callbacks use experimental_onStreamTranscriptionStart and experimental_onStreamTranscriptionEnd. The end event is emitted after the audio stream is consumed and includes the final input byte length.',
+    },
   ]}
 />
 

package/docs/07-reference/01-ai-sdk-core/11-transcribe.mdx

@@ -64,6 +64,13 @@ console.log(transcript);
       isOptional: true,
       description: 'Additional HTTP headers for the request.',
     },
+    {
+      name: 'telemetry',
+      type: 'TelemetryOptions',
+      isOptional: true,
+      description:
+        'Telemetry configuration. Supports functionId, recordInputs, recordOutputs, isEnabled, and per-call integrations.',
+    },
     {
       name: 'download',
       type: '(options: { url: URL; abortSignal?: AbortSignal }) => Promise<{ data: Uint8Array; mediaType: string | undefined }>',

package/docs/07-reference/01-ai-sdk-core/12-generate-speech.mdx

@@ -124,6 +124,13 @@ const { audio } = await generateSpeech({
       isOptional: true,
       description: 'Additional HTTP headers for the request.',
     },
+    {
+      name: 'telemetry',
+      type: 'TelemetryOptions',
+      isOptional: true,
+      description:
+        'Telemetry configuration. Supports functionId, recordInputs, recordOutputs, isEnabled, and per-call integrations.',
+    },
   ]}
 />
 

package/docs/07-reference/01-ai-sdk-core/14-upload-file.mdx

@@ -5,9 +5,9 @@ description: API Reference for uploadFile.
 
 # `uploadFile()`
 
-Uploads a file to a provider and returns a `ProviderReference` that can be used in
-subsequent API calls, such as in message content parts passed to `generateText` or
-`streamText`.
+Uploads a file to a provider and returns a result whose `providerReference` (a
+`ProviderReference`) can be used in subsequent API calls, such as in message
+content parts passed to `generateText` or `streamText`.
 
 ```ts
 import { uploadFile } from 'ai';
@@ -74,7 +74,7 @@ const { providerReference } = await uploadFile({
       type: 'ProviderOptions',
       isOptional: true,
       description:
-        'Additional provider-specific options. For example, OpenAI requires a `purpose` field.',
+        'Additional provider-specific options. For example, OpenAI accepts a `purpose` field, which defaults to `"assistants"`.',
     },
   ]}
 />

package/docs/07-reference/01-ai-sdk-core/14-upload-skill.mdx

@@ -5,7 +5,7 @@ description: API Reference for uploadSkill.
 
 # `uploadSkill()`
 
-Uploads a skill (a bundle of files) to a provider and returns a `ProviderReference` that can be used in subsequent inference calls.
+Uploads a skill (a bundle of files) to a provider and returns a result whose `providerReference` (a `ProviderReference`) can be used in subsequent inference calls.
 
 ```ts
 import { uploadSkill } from 'ai';

package/docs/07-reference/01-ai-sdk-core/15-agent.mdx

@@ -174,7 +174,7 @@ export interface Agent<
 
 ## Method Parameters
 
-Both `generate()` and `stream()` accept an `AgentCallParameters<CALL_OPTIONS, TOOLS>` object with:
+`generate()` accepts an `AgentCallParameters<CALL_OPTIONS, TOOLS>` object, and `stream()` accepts an `AgentStreamParameters<CALL_OPTIONS, TOOLS>` object, which extends `AgentCallParameters` with an optional `experimental_transform`. Both accept:
 
 - `prompt` (optional): A string prompt or array of `ModelMessage` objects
 - `messages` (optional): An array of `ModelMessage` objects (mutually exclusive with `prompt`)

package/docs/07-reference/01-ai-sdk-core/18-create-agent-ui-stream-response.mdx

@@ -29,13 +29,10 @@ const agent = new ToolLoopAgent({
 export async function POST(request: Request) {
   const { messages } = await request.json();
 
-  // Optional: support cancellation (aborts on disconnect, etc.)
-  const abortController = new AbortController();
-
   return createAgentUIStreamResponse({
     agent,
     uiMessages: messages,
-    abortSignal: abortController.signal, // optional
+    abortSignal: request.signal, // optional: aborts when the client disconnects
     // experimental_sandbox, // optional: passed through to tool execution
     // ...other UIMessageStreamOptions like sendSources, experimental_transform, etc.
   });

package/docs/07-reference/01-ai-sdk-core/22-dynamic-tool.mdx

@@ -20,7 +20,7 @@ import { z } from 'zod';
 
 export const customTool = dynamicTool({
   description: 'Execute a custom user-defined function',
-  inputSchema: z.object({}),
+  inputSchema: z.object({ action: z.string(), parameters: z.unknown() }),
   // input is typed as 'unknown'
   execute: async input => {
     const { action, parameters } = input as any;

package/docs/07-reference/01-ai-sdk-core/23-create-mcp-client.mdx

@@ -13,7 +13,7 @@ Creates a lightweight Model Context Protocol (MCP) client that connects to an MC
 - **Completions**: Methods to request autocompletion suggestions for prompt arguments and resource template variables
 - **Elicitation**: Support for handling server requests for additional input during tool execution
 
-It currently does not support accepting notifications from an MCP server, and custom configuration of the client.
+It currently does not support accepting notifications from an MCP server.
 
 ## Import
 

package/docs/07-reference/01-ai-sdk-core/30-model-message.mdx

@@ -228,7 +228,7 @@ export interface ToolResultPart {
   /**
    * Result of the tool call. This is a JSON-serializable object.
    */
-  output: LanguageModelV4ToolResultOutput;
+  output: ToolResultOutput;
 
   /**
   Additional provider-specific metadata. They are passed through
@@ -239,7 +239,7 @@ export interface ToolResultPart {
 }
 ```
 
-### `LanguageModelV4ToolResultOutput`
+### `ToolResultOutput`
 
 ```ts
 /**

package/docs/07-reference/01-ai-sdk-core/69-add-tool-input-examples-middleware.mdx

@@ -60,7 +60,7 @@ A [LanguageModelMiddleware](/docs/ai-sdk-core/middleware) that:
 
 - Locates function tools with an `inputExamples` property.
 - Serializes each input example (by default as JSON, or using your custom formatter).
-- Prepends a section at the end of the tool description containing all formatted examples, prefixed by the `prefix`.
+- Appends a section at the end of the tool description containing all formatted examples, prefixed by the `prefix`.
 - Removes the `inputExamples` property from the tool (unless `remove: false`).
 - Passes through all other tools (including those without examples) unchanged.
 

package/docs/07-reference/01-ai-sdk-core/80-smooth-stream.mdx

@@ -6,7 +6,7 @@ description: Stream transformer for smoothing text and reasoning output
 # `smoothStream()`
 
 `smoothStream` is a utility function that creates a TransformStream
-for the `streamText` `transform` option
+for the `streamText` `experimental_transform` option
 to smooth out text and reasoning streaming by buffering and releasing complete chunks with configurable delays.
 This creates a more natural reading experience when streaming text and reasoning responses.
 

package/docs/07-reference/02-ai-sdk-ui/31-convert-to-model-messages.mdx

@@ -110,7 +110,7 @@ const screenshotTool = tool({
 
 const result = streamText({
   model: __MODEL__,
-  messages: convertToModelMessages(messages, {
+  messages: await convertToModelMessages(messages, {
     tools: {
       screenshot: screenshotTool,
     },
@@ -134,6 +134,7 @@ import {
   createUIMessageStreamResponse,
   streamText,
   toUIMessageStream,
+  type UIMessage,
 } from 'ai';
 
 type CustomUIMessage = UIMessage<
@@ -149,7 +150,7 @@ export async function POST(req: Request) {
 
   const result = streamText({
     model: __MODEL__,
-    messages: convertToModelMessages<CustomUIMessage>(messages, {
+    messages: await convertToModelMessages<CustomUIMessage>(messages, {
       convertDataPart: part => {
         // Convert URL attachments to text
         if (part.type === 'data-url') {
@@ -219,7 +220,7 @@ Only data parts for which you return a text or file model message part are inclu
 all other data parts are ignored.
 
 ```ts
-const result = convertToModelMessages<
+const result = await convertToModelMessages<
   UIMessage<
     unknown,
     {
@@ -237,7 +238,7 @@ const result = convertToModelMessages<
       };
     }
 
-    // data-code and data-node are ignored
+    // data-code and data-note are ignored
   },
 });
 ```

package/docs/07-reference/02-ai-sdk-ui/40-create-ui-message-stream.mdx

@@ -62,7 +62,8 @@ const stream = createUIMessageStream({
       }),
     );
   },
-  onError: error => `Custom error: ${error.message}`,
+  onError: error =>
+    `Custom error: ${error instanceof Error ? error.message : String(error)}`,
   originalMessages: existingMessages,
   onEnd: ({ messages, isContinuation, outcome, responseMessage }) => {
     console.log('Stream ended with messages:', messages);
@@ -124,7 +125,7 @@ outcomes and call `setOutcome` once.
       name: 'onError',
       type: '(error: unknown) => string',
       description:
-        'A function that handles errors and returns an error message string. By default, it returns the error message.',
+        'A function that handles errors and returns an error message string. By default, it returns `"An error occurred."` so server-side error details are not sent to the client.',
     },
     {
       name: 'originalMessages',

package/docs/07-reference/02-ai-sdk-ui/41-create-ui-message-stream-response.mdx

@@ -108,6 +108,13 @@ const response = createUIMessageStreamResponse({
       isOptional: true,
       description: 'Additional headers for the response.',
     },
+    {
+      name: 'keepAliveMs',
+      type: 'number',
+      isOptional: true,
+      description:
+        'Interval in milliseconds for sending SSE keep-alive comments. When set, an opening comment is sent immediately and additional comments are sent after the stream has been idle for the configured interval.',
+    },
     {
       name: 'consumeSseStream',
       type: '(options: { stream: ReadableStream<string> }) => PromiseLike<void> | void',

package/docs/07-reference/02-ai-sdk-ui/42-pipe-ui-message-stream-to-response.mdx

@@ -66,6 +66,13 @@ await pipeUIMessageStreamToResponse({
       isOptional: true,
       description: 'Additional headers for the response.',
     },
+    {
+      name: 'keepAliveMs',
+      type: 'number',
+      isOptional: true,
+      description:
+        'Interval in milliseconds for sending SSE keep-alive comments. When set, an opening comment is sent immediately and additional comments are sent after the stream has been idle for the configured interval.',
+    },
     {
       name: 'consumeSseStream',
       type: '({ stream }: { stream: ReadableStream<string> }) => PromiseLike<void> | void',