@ai-sdk/xai 4.0.0-beta.20 → 4.0.0-beta.23

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @ai-sdk/xai
 
+## 4.0.0-beta.23
+
+### Patch Changes
+
+- c29a26f: feat(provider): add support for provider references and uploading files as supported per provider
+- Updated dependencies [c29a26f]
+  - @ai-sdk/openai-compatible@3.0.0-beta.14
+  - @ai-sdk/provider-utils@5.0.0-beta.10
+  - @ai-sdk/provider@4.0.0-beta.6
+
+## 4.0.0-beta.22
+
+### Patch Changes
+
+- f51c95e: feat(provider/xai): add video extension and reference-to-video (R2V) support
+
+## 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

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,7 +1,7 @@
 import { z } from 'zod/v4';
-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';
+import { InferSchema, FetchFunction } from '@ai-sdk/provider-utils';
+import { ProviderV4, LanguageModelV4, ImageModelV4, Experimental_VideoModelV4, FilesV4 } from '@ai-sdk/provider';
 
 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<{
@@ -102,13 +102,83 @@ type XaiImageModelOptions = z.infer<typeof xaiImageModelOptions>;
 
 type XaiVideoModelId = 'grok-imagine-video' | (string & {});
 
-type XaiVideoModelOptions = {
+declare const resolutionSchema: z.ZodEnum<{
+    "480p": "480p";
+    "720p": "720p";
+}>;
+type XaiVideoResolution = z.infer<typeof resolutionSchema>;
+interface XaiVideoSharedOptions {
     pollIntervalMs?: number | null;
     pollTimeoutMs?: number | null;
-    resolution?: '480p' | '720p' | null;
-    videoUrl?: string | null;
-    [key: string]: unknown;
-};
+    resolution?: XaiVideoResolution | null;
+}
+interface XaiVideoEditModeOptions extends XaiVideoSharedOptions {
+    /**
+     * Select edit-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'edit-video';
+    /** Source video URL to edit. */
+    videoUrl: string;
+}
+interface XaiVideoExtendModeOptions extends XaiVideoSharedOptions {
+    /**
+     * Select extend-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'extend-video';
+    /** Source video URL to extend from its last frame. */
+    videoUrl: string;
+}
+interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Select reference-to-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'reference-to-video';
+    /** Reference image URLs (1-7) for R2V generation. */
+    referenceImageUrls: string[];
+}
+interface XaiVideoGenerationOptions extends XaiVideoSharedOptions {
+    mode?: undefined;
+    videoUrl?: undefined;
+    referenceImageUrls?: undefined;
+}
+interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Legacy backward-compatible shape: omitting `mode` while providing
+     * `videoUrl` behaves like edit-video.
+     */
+    mode?: undefined;
+    videoUrl: string;
+}
+interface XaiLegacyReferenceToVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Legacy backward-compatible shape: omitting `mode` while providing
+     * `referenceImageUrls` behaves like reference-to-video.
+     */
+    mode?: undefined;
+    referenceImageUrls: string[];
+}
+/**
+ * Provider options for xAI video generation.
+ *
+ * Use the `mode` option to select the operation:
+ *
+ * - `'edit-video'`         + `videoUrl`           -- video editing   (`POST /v1/videos/edits`)
+ * - `'extend-video'`       + `videoUrl`           -- video extension (`POST /v1/videos/extensions`)
+ * - `'reference-to-video'` + `referenceImageUrls` -- R2V generation  (`POST /v1/videos/generations`)
+ * - no `mode`                                     -- standard generation from text prompts or image input
+ *
+ * Runtime remains backward compatible with legacy auto-detected provider
+ * options, but the public TypeScript type is intentionally explicit so editors
+ * can suggest valid modes and flag invalid field combinations.
+ */
+type XaiVideoModelOptions = XaiVideoGenerationOptions | XaiVideoEditModeOptions | XaiVideoExtendModeOptions | XaiVideoReferenceToVideoOptions | XaiLegacyEditVideoOptions | XaiLegacyReferenceToVideoOptions;
+
+declare const xaiFilesOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    [x: string]: unknown;
+    teamId?: string | undefined;
+    filePath?: string | undefined;
+}>;
+type XaiFilesOptions = InferSchema<typeof xaiFilesOptionsSchema>;
 
 type XaiImageModelId = 'grok-imagine-image' | 'grok-imagine-image-pro' | (string & {});
 
@@ -341,6 +411,10 @@ interface XaiProvider extends ProviderV4 {
      * Creates an Xai video model for video generation.
      */
     videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV4;
+    /**
+     * Returns the xAI files interface for uploading files.
+     */
+    files(): FilesV4;
     /**
      * Server-side agentic tools for use with the responses API.
      */
@@ -374,4 +448,4 @@ declare const xai: XaiProvider;
 
 declare const VERSION: string;
 
-export { VERSION, type XaiErrorData, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };
+export { VERSION, type XaiErrorData, type XaiFilesOptions, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod/v4';
-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';
+import { InferSchema, FetchFunction } from '@ai-sdk/provider-utils';
+import { ProviderV4, LanguageModelV4, ImageModelV4, Experimental_VideoModelV4, FilesV4 } from '@ai-sdk/provider';
 
 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<{
@@ -102,13 +102,83 @@ type XaiImageModelOptions = z.infer<typeof xaiImageModelOptions>;
 
 type XaiVideoModelId = 'grok-imagine-video' | (string & {});
 
-type XaiVideoModelOptions = {
+declare const resolutionSchema: z.ZodEnum<{
+    "480p": "480p";
+    "720p": "720p";
+}>;
+type XaiVideoResolution = z.infer<typeof resolutionSchema>;
+interface XaiVideoSharedOptions {
     pollIntervalMs?: number | null;
     pollTimeoutMs?: number | null;
-    resolution?: '480p' | '720p' | null;
-    videoUrl?: string | null;
-    [key: string]: unknown;
-};
+    resolution?: XaiVideoResolution | null;
+}
+interface XaiVideoEditModeOptions extends XaiVideoSharedOptions {
+    /**
+     * Select edit-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'edit-video';
+    /** Source video URL to edit. */
+    videoUrl: string;
+}
+interface XaiVideoExtendModeOptions extends XaiVideoSharedOptions {
+    /**
+     * Select extend-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'extend-video';
+    /** Source video URL to extend from its last frame. */
+    videoUrl: string;
+}
+interface XaiVideoReferenceToVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Select reference-to-video mode explicitly for best autocomplete and narrowing.
+     */
+    mode: 'reference-to-video';
+    /** Reference image URLs (1-7) for R2V generation. */
+    referenceImageUrls: string[];
+}
+interface XaiVideoGenerationOptions extends XaiVideoSharedOptions {
+    mode?: undefined;
+    videoUrl?: undefined;
+    referenceImageUrls?: undefined;
+}
+interface XaiLegacyEditVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Legacy backward-compatible shape: omitting `mode` while providing
+     * `videoUrl` behaves like edit-video.
+     */
+    mode?: undefined;
+    videoUrl: string;
+}
+interface XaiLegacyReferenceToVideoOptions extends XaiVideoSharedOptions {
+    /**
+     * Legacy backward-compatible shape: omitting `mode` while providing
+     * `referenceImageUrls` behaves like reference-to-video.
+     */
+    mode?: undefined;
+    referenceImageUrls: string[];
+}
+/**
+ * Provider options for xAI video generation.
+ *
+ * Use the `mode` option to select the operation:
+ *
+ * - `'edit-video'`         + `videoUrl`           -- video editing   (`POST /v1/videos/edits`)
+ * - `'extend-video'`       + `videoUrl`           -- video extension (`POST /v1/videos/extensions`)
+ * - `'reference-to-video'` + `referenceImageUrls` -- R2V generation  (`POST /v1/videos/generations`)
+ * - no `mode`                                     -- standard generation from text prompts or image input
+ *
+ * Runtime remains backward compatible with legacy auto-detected provider
+ * options, but the public TypeScript type is intentionally explicit so editors
+ * can suggest valid modes and flag invalid field combinations.
+ */
+type XaiVideoModelOptions = XaiVideoGenerationOptions | XaiVideoEditModeOptions | XaiVideoExtendModeOptions | XaiVideoReferenceToVideoOptions | XaiLegacyEditVideoOptions | XaiLegacyReferenceToVideoOptions;
+
+declare const xaiFilesOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    [x: string]: unknown;
+    teamId?: string | undefined;
+    filePath?: string | undefined;
+}>;
+type XaiFilesOptions = InferSchema<typeof xaiFilesOptionsSchema>;
 
 type XaiImageModelId = 'grok-imagine-image' | 'grok-imagine-image-pro' | (string & {});
 
@@ -341,6 +411,10 @@ interface XaiProvider extends ProviderV4 {
      * Creates an Xai video model for video generation.
      */
     videoModel(modelId: XaiVideoModelId): Experimental_VideoModelV4;
+    /**
+     * Returns the xAI files interface for uploading files.
+     */
+    files(): FilesV4;
     /**
      * Server-side agentic tools for use with the responses API.
      */
@@ -374,4 +448,4 @@ declare const xai: XaiProvider;
 
 declare const VERSION: string;
 
-export { VERSION, type XaiErrorData, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };
+export { VERSION, type XaiErrorData, type XaiFilesOptions, type XaiImageModelOptions, type XaiImageModelOptions as XaiImageProviderOptions, type XaiLanguageModelChatOptions, type XaiLanguageModelResponsesOptions, type XaiProvider, type XaiLanguageModelChatOptions as XaiProviderOptions, type XaiProviderSettings, type XaiLanguageModelResponsesOptions as XaiResponsesProviderOptions, type XaiVideoModelId, type XaiVideoModelOptions, type XaiVideoModelOptions as XaiVideoProviderOptions, codeExecution, createXai, mcpServer, viewImage, viewXVideo, webSearch, xSearch, xai, xaiTools };