@ai-sdk/xai 4.0.44 → 4.0.48

package/docs/01-xai.mdx

@@ -625,6 +625,66 @@ The following provider options are available:
   tools with client-side function tools in the same request.
 </Note>
 
+## Text Batches
+
+<Note type="warning">
+  Text batch support is experimental and the API may change in patch releases.
+</Note>
+
+The xAI provider supports asynchronous text generation through the
+[Batch API](https://docs.x.ai/developers/advanced-api-usage/batch-api). Use the
+experimental text batch APIs to start a batch, poll its status, and stream its
+results:
+
+```ts
+import { xai } from '@ai-sdk/xai';
+import {
+  experimental_getBatchResults as getBatchResults,
+  experimental_getBatchStatus as getBatchStatus,
+  experimental_startTextBatch as startTextBatch,
+} from 'ai';
+import { setTimeout } from 'node:timers/promises';
+
+const model = xai('grok-4.3');
+
+const batch = await startTextBatch({
+  model,
+  requests: [
+    { id: 'capital-france', prompt: 'What is the capital of France?' },
+    { id: 'capital-germany', prompt: 'What is the capital of Germany?' },
+  ],
+});
+
+let status = batch.status;
+while (status === 'pending') {
+  await setTimeout(60_000);
+  ({ status } = await getBatchStatus({ model, batch }));
+}
+
+for await (const item of getBatchResults({ model, batch })) {
+  if (item.status === 'succeeded') {
+    console.log(item.id, item.text);
+  } else {
+    console.error(item.id, item.error);
+  }
+}
+```
+
+`startTextBatch` returns a serializable batch reference. Persist this reference
+to check the batch status or retrieve its results from another process. Results
+can arrive in a different order from the input requests, so match each result by
+its `id`.
+
+Text batches are available through `xai(modelId)` and
+`xai.responses(modelId)`. The legacy `xai.chat(modelId)` models do not expose
+the batch APIs.
+
+<Note>
+  The xAI Batch API does not support per-batch webhooks. When you provide a
+  `webhookUrl`, the provider returns an unsupported warning and starts the batch
+  without a webhook.
+</Note>
+
 ## Model Capabilities
 
 | Model                         | Image Input | Object Generation | Tool Usage | Tool Streaming | Reasoning |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/xai",
-  "version": "4.0.44",
+  "version": "4.0.48",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -30,7 +30,7 @@
   },
   "dependencies": {
     "@ai-sdk/provider": "4.0.8",
-    "@ai-sdk/provider-utils": "5.0.30"
+    "@ai-sdk/provider-utils": "5.0.32"
   },
   "devDependencies": {
     "@ai-sdk/test-server": "2.0.1",

package/src/responses/xai-responses-api.ts

@@ -168,6 +168,31 @@ const toolCallSchema = z.object({
   action: z.any().optional(),
 });
 
+export const webSearchWireSourceSchema = z.object({
+  type: z.literal('url'),
+  url: z.string(),
+});
+
+export const webSearchWireActionSchema = z.discriminatedUnion('type', [
+  z.object({
+    type: z.literal('search'),
+    query: z.string().nullish(),
+    queries: z.array(z.string()).nullish(),
+    sources: z.array(z.unknown()).nullish(),
+  }),
+  z.object({
+    type: z.literal('open_page'),
+    url: z.string().nullish(),
+    sources: z.array(z.unknown()).nullish(),
+  }),
+  z.object({
+    type: z.literal('find_in_page'),
+    url: z.string().nullish(),
+    pattern: z.string().nullish(),
+    sources: z.array(z.unknown()).nullish(),
+  }),
+]);
+
 const mcpCallSchema = z.object({
   name: z.string().optional(),
   arguments: z.string().optional(),
@@ -260,24 +285,28 @@ const outputItemSchema = z.discriminatedUnion('type', [
   }),
 ]);
 
-export const xaiResponsesUsageSchema = z.object({
-  input_tokens: z.number(),
-  output_tokens: z.number(),
-  total_tokens: z.number().optional(),
-  input_tokens_details: z
-    .object({
-      cached_tokens: z.number().optional(),
-    })
-    .optional(),
-  output_tokens_details: z
-    .object({
-      reasoning_tokens: z.number().optional(),
-    })
-    .optional(),
-  num_sources_used: z.number().optional(),
-  num_server_side_tools_used: z.number().optional(),
-  cost_in_usd_ticks: z.number().nullish(),
-});
+export const xaiResponsesUsageSchema = z
+  .object({
+    input_tokens: z.number(),
+    output_tokens: z.number(),
+    total_tokens: z.number().optional(),
+    input_tokens_details: z
+      .object({
+        cached_tokens: z.number().optional(),
+      })
+      .catchall(z.json())
+      .optional(),
+    output_tokens_details: z
+      .object({
+        reasoning_tokens: z.number().optional(),
+      })
+      .catchall(z.json())
+      .optional(),
+    num_sources_used: z.number().optional(),
+    num_server_side_tools_used: z.number().optional(),
+    cost_in_usd_ticks: z.number().nullish(),
+  })
+  .catchall(z.json());
 
 export const xaiResponsesResponseSchema = z.object({
   id: z.string().nullish(),