TanStack · AlemTuzlak · Aug 28, 2026 · Aug 27, 2026
diff --git a/docs/reference/classes/SkillLimitError.md b/docs/reference/classes/SkillLimitError.md
@@ -0,0 +1,98 @@
+---
+id: SkillLimitError
+title: SkillLimitError
+---
+
+# Class: SkillLimitError
+
+Defined in: [packages/ai/src/utilities/errors.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L22)
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new SkillLimitError(init): SkillLimitError;
+```
+
+Defined in: [packages/ai/src/utilities/errors.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L30)
+
+#### Parameters
+
+##### init
+
+[`SkillLimitErrorInit`](../interfaces/SkillLimitErrorInit.md)
+
+#### Returns
+
+`SkillLimitError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### actual
+
+```ts
+readonly actual: number;
+```
+
+Defined in: [packages/ai/src/utilities/errors.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L27)
+
+***
+
+### allowed
+
+```ts
+readonly allowed: number;
+```
+
+Defined in: [packages/ai/src/utilities/errors.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L26)
+
+***
+
+### limit
+
+```ts
+readonly limit: string;
+```
+
+Defined in: [packages/ai/src/utilities/errors.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L25)
+
+***
+
+### offending
+
+```ts
+readonly offending: string[];
+```
+
+Defined in: [packages/ai/src/utilities/errors.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L28)
+
+***
+
+### path
+
+```ts
+readonly path: "native" | "portable";
+```
+
+Defined in: [packages/ai/src/utilities/errors.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L24)
+
+***
+
+### provider
+
+```ts
+readonly provider: "anthropic" | "openai" | "gemini" | "other";
+```
+
+Defined in: [packages/ai/src/utilities/errors.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L23)
diff --git a/docs/reference/classes/StreamProcessor.md b/docs/reference/classes/StreamProcessor.md
@@ -5,7 +5,7 @@ title: StreamProcessor
 
 # Class: StreamProcessor
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:182](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L182)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:183](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L183)
 
 StreamProcessor - State machine for processing AI response streams
 
@@ -32,7 +32,7 @@ State tracking:
 new StreamProcessor(options?): StreamProcessor;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:219](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L219)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:221](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L221)
 
 #### Parameters
 
@@ -52,7 +52,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:219](https://gi
 addToolApprovalResponse(approvalId, approved): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:383](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L383)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:385](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L385)
 
 Add an approval response (called by client after handling onApprovalRequest)
 
@@ -81,7 +81,7 @@ addToolResult(
    error?): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:339](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L339)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:341](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L341)
 
 Add a tool result (called by client after handling onToolCall)
 
@@ -114,7 +114,7 @@ addUserMessage(
    metadata?): UIMessage;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:267](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L267)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:269](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L269)
 
 Add a user message to the conversation.
 Supports both simple string content and multimodal content arrays.
@@ -169,7 +169,7 @@ processor.addUserMessage('Hello!', 'custom-id-123')
 areAllToolsComplete(): boolean;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:414](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L414)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:416](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L416)
 
 Check if all tool calls in the last assistant message are complete
 Useful for auto-continue logic
@@ -186,7 +186,7 @@ Useful for auto-continue logic
 clearMessages(): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:486](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L486)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:488](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L488)
 
 Clear all messages
 
@@ -202,7 +202,7 @@ Clear all messages
 finalizeStream(): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2337](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2337)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2388](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2388)
 
 Finalize the stream — complete all pending operations.
 
@@ -226,7 +226,7 @@ docs/chat-architecture.md#single-shot-text-response — Finalization step
 getCurrentAssistantMessageId(): string | null;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:323](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L323)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:325](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L325)
 
 Get the current assistant message ID (if one has been created).
 Returns null if prepareAssistantMessage() was called but no content
@@ -244,7 +244,7 @@ has arrived yet.
 getMessages(): UIMessage<unknown>[];
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:406](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L406)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:408](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L408)
 
 Get current messages
 
@@ -260,7 +260,7 @@ Get current messages
 getRecording(): ChunkRecording | null;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2501](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2501)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2554](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2554)
 
 Get the current recording
 
@@ -276,7 +276,7 @@ Get the current recording
 getState(): ProcessorState;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2458](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2458)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2511](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2511)
 
 Get current processor state (aggregated across all messages)
 
@@ -292,7 +292,7 @@ Get current processor state (aggregated across all messages)
 prepareAssistantMessage(): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:302](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L302)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:304](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L304)
 
 Prepare for a new assistant message stream.
 Does NOT create the message immediately -- the message is created lazily
@@ -312,7 +312,7 @@ auto-continuation produces no content.
 process(stream): Promise<ProcessorResult>;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:504](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L504)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:506](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L506)
 
 Process a stream and emit events through handlers
 
@@ -334,7 +334,7 @@ Process a stream and emit events through handlers
 processChunk(chunk): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:538](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L538)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:540](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L540)
 
 Process a single chunk from the stream.
 
@@ -364,7 +364,7 @@ docs/chat-architecture.md#adapter-contract — Expected event types and ordering
 removeMessagesAfter(index): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:454](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L454)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:456](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L456)
 
 Remove messages after a certain index (for reload/retry)
 
@@ -386,7 +386,7 @@ Remove messages after a certain index (for reload/retry)
 reset(): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2526](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2526)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2580](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2580)
 
 Full reset (including messages)
 
@@ -402,7 +402,7 @@ Full reset (including messages)
 setMessages(messages): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:238](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L238)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:240](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L240)
 
 Set the messages array (e.g., from persisted state)
 
@@ -424,7 +424,7 @@ Set the messages array (e.g., from persisted state)
 startAssistantMessage(messageId?): string;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:311](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L311)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:313](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L313)
 
 #### Parameters
 
@@ -449,7 +449,7 @@ an assistant message which can cause empty message flicker.
 startRecording(): void;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2488](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2488)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2541](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2541)
 
 Start recording chunks
 
@@ -468,7 +468,7 @@ toModelMessages(): ModelMessage<
   | null>[];
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:395](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L395)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:397](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L397)
 
 Get the conversation as ModelMessages (for sending to LLM)
 
@@ -487,7 +487,7 @@ Get the conversation as ModelMessages (for sending to LLM)
 static replay(recording, options?): Promise<ProcessorResult>;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2545](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2545)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2599](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2599)
 
 Replay a recording through the processor
 

diff --git a/docs/reference/functions/chat.md b/docs/reference/functions/chat.md
@@ -9,7 +9,7 @@ title: chat
 function chat<TAdapter, TSchema, TStream, TTools, TInterrupts, TContext, TMiddleware>(options): TextActivityResult<TSchema, TStream, TTools>;
 ```
 
-Defined in: [packages/ai/src/activities/chat/index.ts:4549](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L4549)
+Defined in: [packages/ai/src/activities/chat/index.ts:4548](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L4548)
 
 Text activity - handles agentic text generation, one-shot text generation, and agentic structured output.
 

diff --git a/docs/reference/functions/convertMessagesToModelMessages.md b/docs/reference/functions/convertMessagesToModelMessages.md
@@ -12,7 +12,7 @@ function convertMessagesToModelMessages(messages): ModelMessage<
   | null>[];
 ```
 
-Defined in: [packages/ai/src/activities/chat/messages.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L118)
+Defined in: [packages/ai/src/activities/chat/messages.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L136)
 
 Convert UIMessages or ModelMessages to ModelMessages
 

diff --git a/docs/reference/functions/createChatOptions.md b/docs/reference/functions/createChatOptions.md
@@ -9,7 +9,7 @@ title: createChatOptions
 function createChatOptions<TAdapter, TSchema, TStream, TTools, TInterrupts, TContext, TMiddleware>(options): Omit<TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>>, "middleware" | "tools" | "interrupts"> & object;
 ```
 
-Defined in: [packages/ai/src/activities/chat/index.ts:595](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L595)
+Defined in: [packages/ai/src/activities/chat/index.ts:594](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L594)
 
 Create typed options for the chat() function without executing.
 This is useful for pre-defining configurations with full type inference.

diff --git a/docs/reference/functions/createReplayStream.md b/docs/reference/functions/createReplayStream.md
@@ -9,7 +9,7 @@ title: createReplayStream
 function createReplayStream(recording): AsyncIterable<AGUIEvent>;
 ```
 
-Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2557](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2557)
+Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2611](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2611)
 
 Create an async iterable from a recording
 

diff --git a/docs/reference/functions/generateMessageId.md b/docs/reference/functions/generateMessageId.md
@@ -9,7 +9,7 @@ title: generateMessageId
 function generateMessageId(): string;
 ```
 
-Defined in: [packages/ai/src/activities/chat/messages.ts:854](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L854)
+Defined in: [packages/ai/src/activities/chat/messages.ts:1137](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1137)
 
 Generate a unique message ID
 

diff --git a/docs/reference/functions/modelMessageToUIMessage.md b/docs/reference/functions/modelMessageToUIMessage.md
@@ -9,7 +9,7 @@ title: modelMessageToUIMessage
 function modelMessageToUIMessage(modelMessage, id?): UIMessage;
 ```
 
-Defined in: [packages/ai/src/activities/chat/messages.ts:534](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L534)
+Defined in: [packages/ai/src/activities/chat/messages.ts:706](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L706)
 
 Convert a ModelMessage to UIMessage
 

diff --git a/docs/reference/functions/modelMessagesToUIMessages.md b/docs/reference/functions/modelMessagesToUIMessages.md
@@ -9,7 +9,7 @@ title: modelMessagesToUIMessages
 function modelMessagesToUIMessages(modelMessages): UIMessage<unknown>[];
 ```
 
-Defined in: [packages/ai/src/activities/chat/messages.ts:769](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L769)
+Defined in: [packages/ai/src/activities/chat/messages.ts:1041](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1041)
 
 Convert an array of ModelMessages to UIMessages
 

diff --git a/docs/reference/functions/normalizeToUIMessage.md b/docs/reference/functions/normalizeToUIMessage.md
@@ -9,7 +9,7 @@ title: normalizeToUIMessage
 function normalizeToUIMessage(message, generateId): UIMessage;
 ```
 
-Defined in: [packages/ai/src/activities/chat/messages.ts:831](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L831)
+Defined in: [packages/ai/src/activities/chat/messages.ts:1112](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1112)
 
 Normalize a message (UIMessage or ModelMessage) to a UIMessage
 Ensures the message has an ID and createdAt timestamp

diff --git a/docs/reference/functions/uiMessageToModelMessages.md b/docs/reference/functions/uiMessageToModelMessages.md
@@ -12,7 +12,7 @@ function uiMessageToModelMessages(uiMessage): ModelMessage<
   | null>[];
 ```
 
-Defined in: [packages/ai/src/activities/chat/messages.ts:250](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L250)
+Defined in: [packages/ai/src/activities/chat/messages.ts:425](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L425)
 
 Convert a UIMessage to ModelMessage(s)
 

diff --git a/docs/reference/functions/uiMessagesToWire.md b/docs/reference/functions/uiMessagesToWire.md
@@ -9,7 +9,7 @@ title: uiMessagesToWire
 function uiMessagesToWire(messages, options?): WireMessage[];
 ```
 
-Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L88)
+Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:81](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L81)
 
 Serialize TanStack `UIMessage`s and `ModelMessage`s into the AG-UI
 `RunAgentInput.messages` wire shape. Anchors are spec-only (`id`, `role`,