@ai-sdk/xai 4.0.0-beta.2 → 4.0.0-beta.21

package/CHANGELOG.md

@@ -1,5 +1,153 @@
 # @ai-sdk/xai
 
+## 4.0.0-beta.21
+
+### Patch Changes
+
+- 38fc777: Add AI Gateway hint to provider READMEs
+- Updated dependencies [38fc777]
+  - @ai-sdk/openai-compatible@3.0.0-beta.13
+
+## 4.0.0-beta.20
+
+### Patch Changes
+
+- Updated dependencies [2e17091]
+  - @ai-sdk/provider-utils@5.0.0-beta.9
+  - @ai-sdk/openai-compatible@3.0.0-beta.12
+
+## 4.0.0-beta.19
+
+### Patch Changes
+
+- Updated dependencies [986c6fd]
+- Updated dependencies [493295c]
+  - @ai-sdk/provider-utils@5.0.0-beta.8
+  - @ai-sdk/openai-compatible@3.0.0-beta.11
+
+## 4.0.0-beta.18
+
+### Patch Changes
+
+- 9f20868: fix(provider/xai): correct finish reason for tool calls
+
+## 4.0.0-beta.17
+
+### Patch Changes
+
+- Updated dependencies [1f509d4]
+  - @ai-sdk/provider-utils@5.0.0-beta.7
+  - @ai-sdk/provider@4.0.0-beta.5
+  - @ai-sdk/openai-compatible@3.0.0-beta.10
+
+## 4.0.0-beta.16
+
+### Patch Changes
+
+- 4f91b5d: chore(provider/xai): update Grok 4.20 model IDs to their non-beta versions
+
+## 4.0.0-beta.15
+
+### Patch Changes
+
+- 74d520f: feat: migrate providers to support new top-level `reasoning` parameter
+- Updated dependencies [74d520f]
+  - @ai-sdk/openai-compatible@3.0.0-beta.9
+
+## 4.0.0-beta.14
+
+### Patch Changes
+
+- Updated dependencies [3887c70]
+  - @ai-sdk/provider-utils@5.0.0-beta.6
+  - @ai-sdk/provider@4.0.0-beta.4
+  - @ai-sdk/openai-compatible@3.0.0-beta.8
+
+## 4.0.0-beta.13
+
+### Major Changes
+
+- 776b617: feat(provider): adding new 'custom' content type
+
+### Patch Changes
+
+- Updated dependencies [776b617]
+  - @ai-sdk/provider-utils@5.0.0-beta.5
+  - @ai-sdk/provider@4.0.0-beta.3
+  - @ai-sdk/openai-compatible@3.0.0-beta.7
+
+## 4.0.0-beta.12
+
+### Patch Changes
+
+- d20829e: feat(provider/xai): add moderation error, and costInUsdTicks to video model
+- Updated dependencies [61753c3]
+  - @ai-sdk/provider-utils@5.0.0-beta.4
+  - @ai-sdk/openai-compatible@3.0.0-beta.6
+
+## 4.0.0-beta.11
+
+### Patch Changes
+
+- f7d4f01: feat(provider): add support for `reasoning-file` type for files that are part of reasoning
+- Updated dependencies [f7d4f01]
+  - @ai-sdk/provider-utils@5.0.0-beta.3
+  - @ai-sdk/provider@4.0.0-beta.2
+  - @ai-sdk/openai-compatible@3.0.0-beta.5
+
+## 4.0.0-beta.10
+
+### Patch Changes
+
+- Updated dependencies [5c2a5a2]
+  - @ai-sdk/provider@4.0.0-beta.1
+  - @ai-sdk/openai-compatible@3.0.0-beta.4
+  - @ai-sdk/provider-utils@5.0.0-beta.2
+
+## 4.0.0-beta.9
+
+### Patch Changes
+
+- Updated dependencies [8f3e1da]
+  - @ai-sdk/openai-compatible@3.0.0-beta.3
+
+## 4.0.0-beta.8
+
+### Patch Changes
+
+- 4799fa5: chore(provider/xai): update provider to use v4 types
+
+## 4.0.0-beta.7
+
+### Patch Changes
+
+- 0f11f10: add reasoningSummary to responses API provider options
+- 12115e9: fix reasoning text extraction from content in responses doGenerate
+
+## 4.0.0-beta.6
+
+### Major Changes
+
+- f62681f: feat(provider/xai): make responses api the default
+
+## 4.0.0-beta.5
+
+### Patch Changes
+
+- aa5a583: chore(provider/xai): remove obsolete Grok 2 models now that they are shut down in their API
+
+## 4.0.0-beta.4
+
+### Patch Changes
+
+- 25f1837: feat(xai): add b64_json response format, usage cost tracking, and quality/user parameters for image models
+
+## 4.0.0-beta.3
+
+### Patch Changes
+
+- f5181ad: feat(provider/xai): support multiple input images for image editing
+
 ## 4.0.0-beta.2
 
 ### Patch Changes
@@ -524,13 +672,13 @@
   Before
 
   ```ts
-  model.textEmbeddingModel('my-model-id');
+  model.textEmbeddingModel("my-model-id");
   ```
 
   After
 
   ```ts
-  model.embeddingModel('my-model-id');
+  model.embeddingModel("my-model-id");
   ```
 
 - 2625a04: feat(openai); update spec for mcp approval
@@ -788,13 +936,13 @@
   Before
 
   ```ts
-  model.textEmbeddingModel('my-model-id');
+  model.textEmbeddingModel("my-model-id");
   ```
 
   After
 
   ```ts
-  model.embeddingModel('my-model-id');
+  model.embeddingModel("my-model-id");
   ```
 
 - 8514146: add grok-4-1 model IDs
@@ -1337,7 +1485,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1', {
+    model: luma.image("photon-flash-1", {
       maxImagesPerCall: 5,
       pollIntervalMillis: 500,
     }),
@@ -1350,7 +1498,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1'),
+    model: luma.image("photon-flash-1"),
     prompt,
     n: 10,
     maxImagesPerCall: 5,
@@ -1666,7 +1814,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1', {
+    model: luma.image("photon-flash-1", {
       maxImagesPerCall: 5,
       pollIntervalMillis: 500,
     }),
@@ -1679,7 +1827,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1'),
+    model: luma.image("photon-flash-1"),
     prompt,
     n: 10,
     maxImagesPerCall: 5,

package/README.md

@@ -3,6 +3,8 @@
 The **[xAI Grok provider](https://ai-sdk.dev/providers/ai-sdk-providers/xai)** for the [AI SDK](https://ai-sdk.dev/docs)
 contains language model support for the xAI chat and completion APIs.
 
+> **Deploying to Vercel?** With Vercel's AI Gateway you can access xAI (and hundreds of models from other providers) — no additional packages, API keys, or extra cost. [Get started with AI Gateway](https://vercel.com/ai-gateway).
+
 ## Setup
 
 The xAI Grok provider is available in the `@ai-sdk/xai` module. You can install it with

package/dist/index.d.mts

@@ -1,9 +1,9 @@
 import { z } from 'zod/v4';
-import { ProviderV3, LanguageModelV3, ImageModelV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
+import { ProviderV4, LanguageModelV4, ImageModelV4, Experimental_VideoModelV4 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
-type XaiChatModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | 'grok-code-fast-1' | 'grok-4' | 'grok-4-0709' | 'grok-4-latest' | 'grok-3' | 'grok-3-latest' | 'grok-3-mini' | 'grok-3-mini-latest' | 'grok-2-vision-1212' | 'grok-2-vision' | 'grok-2-vision-latest' | 'grok-2-image-1212' | 'grok-2-image' | 'grok-2-image-latest' | (string & {});
+type XaiChatModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | 'grok-4.20-0309-non-reasoning' | 'grok-4.20-0309-reasoning' | 'grok-4.20-multi-agent-0309' | 'grok-code-fast-1' | 'grok-4' | 'grok-4-0709' | 'grok-4-latest' | 'grok-3' | 'grok-3-latest' | 'grok-3-mini' | 'grok-3-mini-latest' | (string & {});
 declare const xaiLanguageModelChatOptions: z.ZodObject<{
     reasoningEffort: z.ZodOptional<z.ZodEnum<{
         low: "low";
@@ -58,7 +58,7 @@ declare const xaiErrorDataSchema: z.ZodObject<{
 }, z.core.$strip>;
 type XaiErrorData = z.infer<typeof xaiErrorDataSchema>;
 
-type XaiResponsesModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | (string & {});
+type XaiResponsesModelId = 'grok-4-1-fast-reasoning' | 'grok-4-1-fast-non-reasoning' | 'grok-4' | 'grok-4-fast-non-reasoning' | 'grok-4-fast-reasoning' | 'grok-4.20-0309-non-reasoning' | 'grok-4.20-0309-reasoning' | 'grok-4.20-multi-agent-0309' | (string & {});
 /**
  * @see https://docs.x.ai/docs/api-reference#create-new-response
  */
@@ -68,6 +68,11 @@ declare const xaiLanguageModelResponsesOptions: z.ZodObject<{
         high: "high";
         medium: "medium";
     }>>;
+    reasoningSummary: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        concise: "concise";
+        detailed: "detailed";
+    }>>;
     logprobs: z.ZodOptional<z.ZodBoolean>;
     topLogprobs: z.ZodOptional<z.ZodNumber>;
     store: z.ZodOptional<z.ZodBoolean>;
@@ -86,6 +91,12 @@ declare const xaiImageModelOptions: z.ZodObject<{
         "1k": "1k";
         "2k": "2k";
     }>>;
+    quality: z.ZodOptional<z.ZodEnum<{
+        low: "low";
+        high: "high";
+        medium: "medium";
+    }>>;
+    user: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 type XaiImageModelOptions = z.infer<typeof xaiImageModelOptions>;
 
@@ -99,16 +110,16 @@ type XaiVideoModelOptions = {
     [key: string]: unknown;
 };
 
-type XaiImageModelId = 'grok-2-image' | 'grok-2-image-1212' | 'grok-imagine-image' | 'grok-imagine-image-pro' | (string & {});
+type XaiImageModelId = 'grok-imagine-image' | 'grok-imagine-image-pro' | (string & {});
 
 declare const codeExecutionToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
     output: string;
     error?: string | undefined;
-}, object>;
+}, object, {}>;
 declare const codeExecution: (args?: Parameters<typeof codeExecutionToolFactory>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
     output: string;
     error?: string | undefined;
-}>;
+}, {}>;
 
 declare const mcpServerToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     name: string;
@@ -121,32 +132,32 @@ declare const mcpServerToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWi
     allowedTools?: string[];
     headers?: Record<string, string>;
     authorization?: string;
-}>;
+}, {}>;
 declare const mcpServer: (args: Parameters<typeof mcpServerToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
     name: string;
     arguments: string;
     result: unknown;
-}>;
+}, {}>;
 
 declare const viewImageToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
     description: string;
     objects?: string[] | undefined;
-}, object>;
+}, object, {}>;
 declare const viewImage: (args?: Parameters<typeof viewImageToolFactory>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
     description: string;
     objects?: string[] | undefined;
-}>;
+}, {}>;
 
 declare const viewXVideoToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
     description: string;
     transcript?: string | undefined;
     duration?: number | undefined;
-}, object>;
+}, object, {}>;
 declare const viewXVideo: (args?: Parameters<typeof viewXVideoToolFactory>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
     description: string;
     transcript?: string | undefined;
     duration?: number | undefined;
-}>;
+}, {}>;
 
 declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     query: string;
@@ -159,7 +170,7 @@ declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWi
     allowedDomains?: string[];
     excludedDomains?: string[];
     enableImageUnderstanding?: boolean;
-}>;
+}, {}>;
 declare const webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
     query: string;
     sources: Array<{
@@ -167,7 +178,7 @@ declare const webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) =>
         url: string;
         snippet: string;
     }>;
-}>;
+}, {}>;
 
 declare const xSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
     query: string;
@@ -184,7 +195,7 @@ declare const xSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWith
     toDate?: string;
     enableImageUnderstanding?: boolean;
     enableVideoUnderstanding?: boolean;
-}>;
+}, {}>;
 declare const xSearch: (args?: Parameters<typeof xSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
     query: string;
     posts: Array<{
@@ -193,16 +204,16 @@ declare const xSearch: (args?: Parameters<typeof xSearchToolFactory>[0]) => _ai_
         url: string;
         likes: number;
     }>;
-}>;
+}, {}>;
 
 declare const xaiTools: {
     codeExecution: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
         output: string;
         error?: string | undefined;
-    }, object>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
+    }, object, {}>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
         output: string;
         error?: string | undefined;
-    }>;
+    }, {}>;
     fileSearch: (args: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         queries: string[];
         results: null | {
@@ -214,7 +225,7 @@ declare const xaiTools: {
     }, {
         vectorStoreIds: string[];
         maxNumResults?: number;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         queries: string[];
         results: null | {
             fileId: string;
@@ -222,7 +233,7 @@ declare const xaiTools: {
             score: number;
             text: string;
         }[];
-    }>;
+    }, {}>;
     mcpServer: (args: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         name: string;
         arguments: string;
@@ -234,27 +245,27 @@ declare const xaiTools: {
         allowedTools?: string[];
         headers?: Record<string, string>;
         authorization?: string;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         name: string;
         arguments: string;
         result: unknown;
-    }>;
+    }, {}>;
     viewImage: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
         description: string;
         objects?: string[] | undefined;
-    }, object>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
+    }, object, {}>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
         description: string;
         objects?: string[] | undefined;
-    }>;
+    }, {}>;
     viewXVideo: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
         description: string;
         transcript?: string | undefined;
         duration?: number | undefined;
-    }, object>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
+    }, object, {}>>[0]) => _ai_sdk_provider_utils.Tool<Record<string, never>, {
         description: string;
         transcript?: string | undefined;
         duration?: number | undefined;
-    }>;
+    }, {}>;
     webSearch: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         query: string;
         sources: Array<{
@@ -266,14 +277,14 @@ declare const xaiTools: {
         allowedDomains?: string[];
         excludedDomains?: string[];
         enableImageUnderstanding?: boolean;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         query: string;
         sources: Array<{
             title: string;
             url: string;
             snippet: string;
         }>;
-    }>;
+    }, {}>;
     xSearch: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
         query: string;
         posts: Array<{
@@ -289,7 +300,7 @@ declare const xaiTools: {
         toDate?: string;
         enableImageUnderstanding?: boolean;
         enableVideoUnderstanding?: boolean;
-    }>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{}, {
         query: string;
         posts: Array<{
             author: string;
@@ -297,42 +308,39 @@ declare const xaiTools: {
             url: string;
             likes: number;
         }>;
-    }>;
+    }, {}>;
 };
 
-interface XaiProvider extends ProviderV3 {
-    /**
-     * Creates an Xai chat model for text generation.
-     */
-    (modelId: XaiChatModelId): LanguageModelV3;
+interface XaiProvider extends ProviderV4 {
+    (modelId: XaiResponsesModelId): LanguageModelV4;
     /**
      * Creates an Xai language model for text generation.
      */
-    languageModel(modelId: XaiChatModelId): LanguageModelV3;
+    languageModel(modelId: XaiResponsesModelId): LanguageModelV4;
     /**
      * Creates an Xai chat model for text generation.
      */
-    chat: (modelId: XaiChatModelId) => LanguageModelV3;
+    chat: (modelId: XaiChatModelId) => LanguageModelV4;
     /**
-     * Creates an Xai responses model for agentic tool calling.
+     * Creates an Xai responses model for text generation.
      */
-    responses: (modelId: XaiResponsesModelId) => LanguageModelV3;
+    responses: (modelId: XaiResponsesModelId) => LanguageModelV4;
     /**
      * Creates an Xai image model for image generation.
      */
-    image(modelId: XaiImageModelId): ImageModelV3;
+    image(modelId: XaiImageModelId): ImageModelV4;
     /**
      * Creates an Xai image model for image generation.
      */
-    imageModel(modelId: XaiImageModelId): ImageModelV3;
+    imageModel(modelId: XaiImageModelId): ImageModelV4;
     /**
      * Creates an Xai video model for video generation.
      */
-    video(modelId: XaiVideoModelId): Experimental_VideoModelV3;
+    video(modelId: XaiVideoModelId): Experimental_VideoModelV4;
     /**
      * Creates an Xai video model for video generation.
      */
-    videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV3;
+    videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV4;
     /**
      * Server-side agentic tools for use with the responses API.
      */