@ai-sdk/xai 4.0.8 → 4.0.10

package/docs/01-xai.mdx

@@ -12,21 +12,7 @@ The [xAI Grok](https://x.ai) provider contains language model support for the [x
 The xAI Grok provider is available via the `@ai-sdk/xai` module. You can
 install it with
 
-<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
-  <Tab>
-    <Snippet text="pnpm add @ai-sdk/xai" dark />
-  </Tab>
-  <Tab>
-    <Snippet text="npm install @ai-sdk/xai" dark />
-  </Tab>
-  <Tab>
-    <Snippet text="yarn add @ai-sdk/xai" dark />
-  </Tab>
-
-  <Tab>
-    <Snippet text="bun add @ai-sdk/xai" dark />
-  </Tab>
-</Tabs>
+<InstallPackages packages="@ai-sdk/xai" />
 
 ## Provider Instance
 
@@ -212,6 +198,42 @@ const { text } = await generateText({
 });
 ```
 
+You can control the resolution at which the model processes an image with
+the `imageDetail` provider option on the image part:
+
+```ts
+import { xai } from '@ai-sdk/xai';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: xai('grok-4.3'),
+  messages: [
+    {
+      role: 'user',
+      content: [
+        { type: 'text', text: 'What do you see in this image?' },
+        {
+          type: 'file',
+          mediaType: 'image/png',
+          data: fs.readFileSync('./image.png'),
+          providerOptions: {
+            xai: { imageDetail: 'low' },
+          },
+        },
+      ],
+    },
+  ],
+});
+```
+
+The following image detail values are supported:
+
+- **low**: processes the image at reduced resolution and consumes fewer input tokens.
+- **high**: processes the image at full resolution.
+- **auto**: lets the xAI API decide.
+
+When not set, the image is processed at full resolution.
+
 ### Web Search Tool
 
 The web search tool enables autonomous web research with optional domain filtering and image understanding:
@@ -520,18 +542,19 @@ The following provider options are available:
 
 ## Model Capabilities
 
-| Model                         | Image Input         | Object Generation   | Tool Usage          | Tool Streaming      | Reasoning           |
-| ----------------------------- | ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
-| `grok-4.20-reasoning`         | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
-| `grok-4.20-non-reasoning`     | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
-| `grok-4-1-fast-reasoning`     | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
-| `grok-4-1-fast-non-reasoning` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
-| `grok-4-1`                    | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
-| `grok-4-fast-reasoning`       | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
-| `grok-4-fast-non-reasoning`   | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
-| `grok-code-fast-1`            | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
-| `grok-3`                      | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
-| `grok-3-mini`                 | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| Model                         | Image Input | Object Generation | Tool Usage | Tool Streaming | Reasoning |
+| ----------------------------- | ----------- | ----------------- | ---------- | -------------- | --------- |
+| `grok-4.5`                    | <Check />   | <Check />         | <Check />  | <Check />      | <Check /> |
+| `grok-4.20-reasoning`         | <Check />   | <Check />         | <Check />  | <Check />      | <Check /> |
+| `grok-4.20-non-reasoning`     | <Check />   | <Check />         | <Check />  | <Check />      | <Cross /> |
+| `grok-4-1-fast-reasoning`     | <Check />   | <Check />         | <Check />  | <Check />      | <Check /> |
+| `grok-4-1-fast-non-reasoning` | <Check />   | <Check />         | <Check />  | <Check />      | <Cross /> |
+| `grok-4-1`                    | <Cross />   | <Check />         | <Check />  | <Check />      | <Cross /> |
+| `grok-4-fast-reasoning`       | <Check />   | <Check />         | <Check />  | <Check />      | <Check /> |
+| `grok-4-fast-non-reasoning`   | <Check />   | <Check />         | <Check />  | <Check />      | <Cross /> |
+| `grok-code-fast-1`            | <Cross />   | <Check />         | <Check />  | <Check />      | <Check /> |
+| `grok-3`                      | <Cross />   | <Check />         | <Check />  | <Check />      | <Cross /> |
+| `grok-3-mini`                 | <Cross />   | <Check />         | <Check />  | <Check />      | <Check /> |
 
 <Note>
   The table above lists popular models. Please see the [xAI
@@ -639,9 +662,9 @@ const result = await generateSpeech({
 
 ### Model Capabilities
 
-| Model     | Language            | Speed               | Output Formats             |
-| --------- | ------------------- | ------------------- | -------------------------- |
-| `default` | <Check size={18} /> | <Check size={18} /> | mp3, wav, pcm, mulaw, alaw |
+| Model     | Language  | Speed     | Output Formats             |
+| --------- | --------- | --------- | -------------------------- |
+| `default` | <Check /> | <Check /> | mp3, wav, pcm, mulaw, alaw |
 
 ## Transcription Models
 
@@ -746,9 +769,9 @@ const result = await transcribe({
 
 ### Model Capabilities
 
-| Model     | Request/Response    | Streaming           | Word Timestamps     | Diarization         | Multichannel        |
-| --------- | ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
-| `default` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| Model     | Request/Response | Streaming | Word Timestamps | Diarization | Multichannel |
+| --------- | ---------------- | --------- | --------------- | ----------- | ------------ |
+| `default` | <Check />        | <Check /> | <Check />       | <Check />   | <Check />    |
 
 <Note>
   Word timestamps, diarization results, and segments are only returned on the
@@ -883,10 +906,10 @@ const { images } = await generateImage({
 
 ### Image Model Capabilities
 
-| Model                    | Resolution | Aspect Ratios                                                                                               | Image Editing       |
-| ------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------- | ------------------- |
-| `grok-imagine-image-pro` | `1k`, `2k` | `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`, `2:1`, `1:2`, `19.5:9`, `9:19.5`, `20:9`, `9:20`, `auto` | <Check size={18} /> |
-| `grok-imagine-image`     | `1k`       | `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`, `2:1`, `1:2`, `19.5:9`, `9:19.5`, `20:9`, `9:20`, `auto` | <Check size={18} /> |
+| Model                    | Resolution | Aspect Ratios                                                                                               | Image Editing |
+| ------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------- | ------------- |
+| `grok-imagine-image-pro` | `1k`, `2k` | `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`, `2:1`, `1:2`, `19.5:9`, `9:19.5`, `20:9`, `9:20`, `auto` | <Check />     |
+| `grok-imagine-image`     | `1k`       | `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`, `2:1`, `1:2`, `19.5:9`, `9:19.5`, `20:9`, `9:20`, `auto` | <Check />     |
 
 ## Video Models
 
@@ -1232,9 +1255,9 @@ and `resolution` just like text-to-video.
 
 ### Video Model Capabilities
 
-| Model                | Duration | Aspect Ratios                                     | Resolution     | Image-to-Video      | Editing             | Extension           | R2V                 |
-| -------------------- | -------- | ------------------------------------------------- | -------------- | ------------------- | ------------------- | ------------------- | ------------------- |
-| `grok-imagine-video` | 1–15s    | `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3` | `480p`, `720p` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| Model                | Duration | Aspect Ratios                                     | Resolution     | Image-to-Video | Editing   | Extension | R2V       |
+| -------------------- | -------- | ------------------------------------------------- | -------------- | -------------- | --------- | --------- | --------- |
+| `grok-imagine-video` | 1–15s    | `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3` | `480p`, `720p` | <Check />      | <Check /> | <Check /> | <Check /> |
 
 <Note>
   You can also pass any available provider model ID as a string if needed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/xai",
-  "version": "4.0.8",
+  "version": "4.0.10",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -29,9 +29,9 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/openai-compatible": "3.0.5",
-    "@ai-sdk/provider": "4.0.2",
-    "@ai-sdk/provider-utils": "5.0.5"
+    "@ai-sdk/openai-compatible": "3.0.7",
+    "@ai-sdk/provider": "4.0.3",
+    "@ai-sdk/provider-utils": "5.0.7"
   },
   "devDependencies": {
     "@types/node": "22.19.19",

package/src/convert-to-xai-chat-messages.ts

@@ -6,15 +6,19 @@ import {
 import {
   convertToBase64,
   getTopLevelMediaType,
+  parseProviderOptions,
   resolveFullMediaType,
   resolveProviderReference,
 } from '@ai-sdk/provider-utils';
-import type { XaiChatPrompt } from './xai-chat-prompt';
+import type { XaiChatPrompt, XaiUserMessageContent } from './xai-chat-prompt';
+import { xaiFilePartProviderOptions } from './xai-file-part-options';
 
-export function convertToXaiChatMessages(prompt: LanguageModelV4Prompt): {
+export async function convertToXaiChatMessages(
+  prompt: LanguageModelV4Prompt,
+): Promise<{
   messages: XaiChatPrompt;
   warnings: Array<SharedV4Warning>;
-} {
+}> {
   const messages: XaiChatPrompt = [];
   const warnings: Array<SharedV4Warning> = [];
 
@@ -31,54 +35,68 @@ export function convertToXaiChatMessages(prompt: LanguageModelV4Prompt): {
           break;
         }
 
-        messages.push({
-          role: 'user',
-          content: content.map(part => {
-            switch (part.type) {
-              case 'text': {
-                return { type: 'text', text: part.text };
-              }
-              case 'file': {
-                switch (part.data.type) {
-                  case 'reference': {
-                    return {
-                      type: 'file',
-                      file: {
-                        file_id: resolveProviderReference({
-                          reference: part.data.reference,
-                          provider: 'xai',
+        const userContent: Array<XaiUserMessageContent> = [];
+
+        for (const part of content) {
+          switch (part.type) {
+            case 'text': {
+              userContent.push({ type: 'text', text: part.text });
+              break;
+            }
+            case 'file': {
+              switch (part.data.type) {
+                case 'reference': {
+                  userContent.push({
+                    type: 'file',
+                    file: {
+                      file_id: resolveProviderReference({
+                        reference: part.data.reference,
+                        provider: 'xai',
+                      }),
+                    },
+                  });
+                  break;
+                }
+                case 'text': {
+                  throw new UnsupportedFunctionalityError({
+                    functionality: 'text file parts',
+                  });
+                }
+                case 'url':
+                case 'data': {
+                  if (getTopLevelMediaType(part.mediaType) === 'image') {
+                    const filePartOptions = await parseProviderOptions({
+                      provider: 'xai',
+                      providerOptions: part.providerOptions,
+                      schema: xaiFilePartProviderOptions,
+                    });
+
+                    userContent.push({
+                      type: 'image_url',
+                      image_url: {
+                        url:
+                          part.data.type === 'url'
+                            ? part.data.url.toString()
+                            : `data:${resolveFullMediaType({ part })};base64,${convertToBase64(part.data.data)}`,
+                        ...(filePartOptions?.imageDetail != null && {
+                          detail: filePartOptions.imageDetail,
                         }),
                       },
-                    };
-                  }
-                  case 'text': {
+                    });
+                  } else {
                     throw new UnsupportedFunctionalityError({
-                      functionality: 'text file parts',
+                      functionality: `file part media type ${part.mediaType}`,
                     });
                   }
-                  case 'url':
-                  case 'data': {
-                    if (getTopLevelMediaType(part.mediaType) === 'image') {
-                      return {
-                        type: 'image_url',
-                        image_url: {
-                          url:
-                            part.data.type === 'url'
-                              ? part.data.url.toString()
-                              : `data:${resolveFullMediaType({ part })};base64,${convertToBase64(part.data.data)}`,
-                        },
-                      };
-                    } else {
-                      throw new UnsupportedFunctionalityError({
-                        functionality: `file part media type ${part.mediaType}`,
-                      });
-                    }
-                  }
+                  break;
                 }
               }
+              break;
             }
-          }),
-        });
+          }
+        }
+
+        messages.push({ role: 'user', content: userContent });
 
         break;
       }

package/src/index.ts

@@ -4,6 +4,7 @@ export type {
   XaiLanguageModelChatOptions as XaiProviderOptions,
 } from './xai-chat-language-model-options';
 export type { XaiErrorData } from './xai-error';
+export type { XaiFilePartProviderOptions } from './xai-file-part-options';
 export type {
   XaiLanguageModelResponsesOptions,
   /** @deprecated Use `XaiLanguageModelResponsesOptions` instead. */

package/src/responses/convert-to-xai-responses-input.ts

@@ -6,9 +6,11 @@ import {
 import {
   convertToBase64,
   getTopLevelMediaType,
+  parseProviderOptions,
   resolveFullMediaType,
   resolveProviderReference,
 } from '@ai-sdk/provider-utils';
+import { xaiFilePartProviderOptions } from '../xai-file-part-options';
 import type {
   XaiResponsesInput,
   XaiResponsesUserMessageContentPart,
@@ -71,9 +73,18 @@ export async function convertToXaiResponsesInput({
                         ? block.data.url.toString()
                         : `data:${resolveFullMediaType({ part: block })};base64,${convertToBase64(block.data.data)}`;
 
+                    const filePartOptions = await parseProviderOptions({
+                      provider: 'xai',
+                      providerOptions: block.providerOptions,
+                      schema: xaiFilePartProviderOptions,
+                    });
+
                     contentParts.push({
                       type: 'input_image',
                       image_url: imageUrl,
+                      ...(filePartOptions?.imageDetail != null && {
+                        detail: filePartOptions.imageDetail,
+                      }),
                     });
                   } else if (block.data.type === 'url') {
                     // xAI's Responses API accepts non-image documents (PDF, text, CSV, etc.)

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

@@ -26,7 +26,11 @@ export type XaiResponsesSystemMessage = {
 
 export type XaiResponsesUserMessageContentPart =
   | { type: 'input_text'; text: string }
-  | { type: 'input_image'; image_url: string }
+  | {
+      type: 'input_image';
+      image_url: string;
+      detail?: 'low' | 'high' | 'auto';
+    }
   | { type: 'input_file'; file_id: string }
   | { type: 'input_file'; file_url: string };
 

package/src/responses/xai-responses-language-model-options.ts

@@ -4,6 +4,7 @@ export type XaiResponsesModelId =
   | 'grok-4.20-non-reasoning'
   | 'grok-4.20-reasoning'
   | 'grok-4.3'
+  | 'grok-4.5'
   | 'grok-latest'
   | (string & {});
 

package/src/xai-chat-language-model-options.ts

@@ -5,6 +5,7 @@ export type XaiChatModelId =
   | 'grok-4.20-non-reasoning'
   | 'grok-4.20-reasoning'
   | 'grok-4.3'
+  | 'grok-4.5'
   | 'grok-latest'
   | (string & {});
 

package/src/xai-chat-language-model.ts

@@ -126,7 +126,7 @@ export class XaiChatLanguageModel implements LanguageModelV4 {
 
     // convert ai sdk messages to xai format
     const { messages, warnings: messageWarnings } =
-      convertToXaiChatMessages(prompt);
+      await convertToXaiChatMessages(prompt);
     warnings.push(...messageWarnings);
 
     // prepare tools for xai

package/src/xai-chat-prompt.ts

@@ -18,7 +18,10 @@ export interface XaiUserMessage {
 
 export type XaiUserMessageContent =
   | { type: 'text'; text: string }
-  | { type: 'image_url'; image_url: { url: string } }
+  | {
+      type: 'image_url';
+      image_url: { url: string; detail?: 'low' | 'high' | 'auto' };
+    }
   | { type: 'file'; file: { file_id: string } };
 
 export interface XaiAssistantMessage {

package/src/xai-file-part-options.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod/v4';
+
+// provider options for file parts (images) in user messages
+export const xaiFilePartProviderOptions = z.object({
+  /**
+   * Controls the resolution at which the model processes the image.
+   * `low` processes the image at reduced resolution and consumes fewer
+   * input tokens, `high` processes the image at full resolution, and
+   * `auto` lets the API decide. Defaults to full resolution when not set.
+   *
+   * Note: the xAI API silently ignores invalid values, so the value is
+   * validated client-side.
+   *
+   * @see https://docs.x.ai/developers/model-capabilities/images/understanding
+   */
+  imageDetail: z.enum(['low', 'high', 'auto']).optional(),
+});
+
+export type XaiFilePartProviderOptions = z.infer<
+  typeof xaiFilePartProviderOptions
+>;

package/src/xai-video-model.ts

@@ -10,6 +10,7 @@ import {
   createJsonResponseHandler,
   delay,
   getFromApi,
+  getTopLevelMediaType,
   parseProviderOptions,
   postJsonToApi,
   type FetchFunction,
@@ -62,6 +63,9 @@ function resolveStartImage(
   return getFirstFrameImage(options) ?? options.image;
 }
 
+const isVideoFile = (file: Experimental_VideoModelV4File): boolean =>
+  file.mediaType != null && getTopLevelMediaType(file.mediaType) === 'video';
+
 function fileToXaiImageUrl(file: Experimental_VideoModelV4File): string {
   if (file.type === 'url') {
     return file.url;
@@ -71,17 +75,35 @@ function fileToXaiImageUrl(file: Experimental_VideoModelV4File): string {
     typeof file.data === 'string'
       ? file.data
       : convertUint8ArrayToBase64(file.data);
-  return `data:${file.mediaType ?? 'image/png'};base64,${base64Data}`;
+  return `data:${file.mediaType};base64,${base64Data}`;
 }
 
 // Resolves the reference images for R2V generation. First-class
 // `inputReferences` win over the legacy `referenceImageUrls` provider option.
+// Video references are not supported for reference-to-video and are skipped
+// with a warning.
 function resolveReferenceImages(
   options: XaiVideoDoGenerateOptions,
   xaiOptions: XaiParsedVideoModelOptions | undefined,
+  warnings: SharedV4Warning[],
 ): Array<{ url: string }> | undefined {
   if (options.inputReferences != null && options.inputReferences.length > 0) {
-    return options.inputReferences.map(reference => ({
+    const imageReferences = options.inputReferences.filter(reference => {
+      if (isVideoFile(reference)) {
+        warnings.push({
+          type: 'unsupported',
+          feature: 'inputReferences',
+          details:
+            'xAI reference-to-video accepts image references only. The video ' +
+            'reference was ignored. Use providerOptions.xai.mode ' +
+            '"extend-video" to continue from a video.',
+        });
+        return false;
+      }
+      return true;
+    });
+
+    return imageReferences.map(reference => ({
       url: fileToXaiImageUrl(reference),
     }));
   }
@@ -278,24 +300,44 @@ export class XaiVideoModel implements Experimental_VideoModelV4 {
     // nested xAI request image object.
     const startImage = resolveStartImage(options);
     if (startImage != null) {
-      body.image = { url: fileToXaiImageUrl(startImage) };
+      if (isVideoFile(startImage)) {
+        const fromFrameImages = getFirstFrameImage(options) != null;
+        warnings.push({
+          type: 'unsupported',
+          feature: fromFrameImages ? 'frameImages' : 'image',
+          details:
+            'xAI does not accept a video as a start/frame image. The video ' +
+            'was ignored. Use providerOptions.xai.mode "extend-video" to ' +
+            'continue from a video instead.',
+        });
+      } else {
+        body.image = { url: fileToXaiImageUrl(startImage) };
+      }
     }
 
     // xAI has no first-last-frame interpolation; warn and ignore last_frame.
-    if (getLastFrameImage(options) != null) {
+    const lastFrameImage = getLastFrameImage(options);
+    if (lastFrameImage != null) {
       warnings.push({
         type: 'unsupported',
         feature: 'frameImages',
-        details:
-          'xAI video models do not support last_frame. Use ' +
-          'providerOptions.xai.mode "extend-video" to continue from a ' +
-          "video's last frame. The last frame image was ignored.",
+        details: isVideoFile(lastFrameImage)
+          ? 'xAI does not accept a video as a start/frame image. The video ' +
+            'last frame was ignored. Use providerOptions.xai.mode ' +
+            '"extend-video" to continue from a video instead.'
+          : 'xAI video models do not support last_frame. Use ' +
+            'providerOptions.xai.mode "extend-video" to continue from a ' +
+            "video's last frame. The last frame image was ignored.",
       });
     }
 
     // Reference images for R2V (reference-to-video) generation
     if (hasReferenceImages) {
-      const referenceImages = resolveReferenceImages(options, xaiOptions);
+      const referenceImages = resolveReferenceImages(
+        options,
+        xaiOptions,
+        warnings,
+      );
       if (referenceImages != null) {
         body.reference_images = referenceImages;
       }