@ai-sdk/xai 3.0.69 → 3.0.71

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/xai
 
+## 3.0.71
+
+### Patch Changes
+
+- 55ccbe2: chore(provider/xai): remove obsolete Grok 2 models now that they are shut down in their API
+
+## 3.0.70
+
+### Patch Changes
+
+- 49ae502: feat(xai): add b64_json response format, usage cost tracking, and quality/user parameters for image models
+
 ## 3.0.69
 
 ### Patch Changes

package/dist/index.d.mts

@@ -3,7 +3,7 @@ import { ProviderV3, LanguageModelV3, ImageModelV3, Experimental_VideoModelV3 }
 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-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";
@@ -86,6 +86,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,7 +105,7 @@ 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;

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { ProviderV3, LanguageModelV3, ImageModelV3, Experimental_VideoModelV3 }
 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-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";
@@ -86,6 +86,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,7 +105,7 @@ 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;

package/dist/index.js

@@ -893,7 +893,9 @@ var xaiImageModelOptions = import_v44.z.object({
   aspect_ratio: import_v44.z.string().optional(),
   output_format: import_v44.z.string().optional(),
   sync_mode: import_v44.z.boolean().optional(),
-  resolution: import_v44.z.enum(["1k", "2k"]).optional()
+  resolution: import_v44.z.enum(["1k", "2k"]).optional(),
+  quality: import_v44.z.enum(["low", "medium", "high"]).optional(),
+  user: import_v44.z.string().optional()
 });
 
 // src/xai-image-model.ts
@@ -919,7 +921,7 @@ var XaiImageModel = class {
     files,
     mask
   }) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     const warnings = [];
     if (size != null) {
       warnings.push({
@@ -952,7 +954,7 @@ var XaiImageModel = class {
       model: this.modelId,
       prompt,
       n,
-      response_format: "url"
+      response_format: "b64_json"
     };
     if (aspectRatio != null) {
       body.aspect_ratio = aspectRatio;
@@ -969,6 +971,12 @@ var XaiImageModel = class {
     if ((xaiOptions == null ? void 0 : xaiOptions.resolution) != null) {
       body.resolution = xaiOptions.resolution;
     }
+    if ((xaiOptions == null ? void 0 : xaiOptions.quality) != null) {
+      body.quality = xaiOptions.quality;
+    }
+    if ((xaiOptions == null ? void 0 : xaiOptions.user) != null) {
+      body.user = xaiOptions.user;
+    }
     if (imageUrls.length === 1) {
       body.image = { url: imageUrls[0], type: "image_url" };
     } else if (imageUrls.length > 1) {
@@ -987,11 +995,14 @@ var XaiImageModel = class {
       abortSignal,
       fetch: this.config.fetch
     });
-    const downloadedImages = await Promise.all(
-      response.data.map((image) => this.downloadImage(image.url, abortSignal))
+    const hasAllBase64 = response.data.every((image) => image.b64_json != null);
+    const images = hasAllBase64 ? response.data.map((image) => image.b64_json) : await Promise.all(
+      response.data.map(
+        (image) => this.downloadImage(image.url, abortSignal)
+      )
     );
     return {
-      images: downloadedImages,
+      images,
       warnings,
       response: {
         timestamp: currentDate,
@@ -1002,7 +1013,8 @@ var XaiImageModel = class {
         xai: {
           images: response.data.map((item) => ({
             ...item.revised_prompt ? { revisedPrompt: item.revised_prompt } : {}
-          }))
+          })),
+          ...((_e = response.usage) == null ? void 0 : _e.cost_in_usd_ticks) != null ? { costInUsdTicks: response.usage.cost_in_usd_ticks } : {}
         }
       }
     };
@@ -1021,10 +1033,14 @@ var XaiImageModel = class {
 var xaiImageResponseSchema = import_v45.z.object({
   data: import_v45.z.array(
     import_v45.z.object({
-      url: import_v45.z.string(),
+      url: import_v45.z.string().nullish(),
+      b64_json: import_v45.z.string().nullish(),
       revised_prompt: import_v45.z.string().nullish()
     })
-  )
+  ),
+  usage: import_v45.z.object({
+    cost_in_usd_ticks: import_v45.z.number().nullish()
+  }).nullish()
 });
 
 // src/responses/xai-responses-language-model.ts
@@ -2699,7 +2715,7 @@ var xaiTools = {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.69" : "0.0.0-test";
+var VERSION = true ? "3.0.71" : "0.0.0-test";
 
 // src/xai-video-model.ts
 var import_provider6 = require("@ai-sdk/provider");