@ai-sdk/provider 4.0.4 → 4.0.5

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/provider
 
+## 4.0.5
+
+### Patch Changes
+
+- 79e133c: async APIs for generateVideo (poll, webhook)
+
+  Adds an asynchronous start/status flow to the experimental video model
+  interface (`VideoModelV4`): models may now implement `doStart`, `doStatus`,
+  and `handleWebhookOption` instead of (or in addition to) `doGenerate`, and
+  `experimental_generateVideo` accepts `poll` and `webhook` options to
+  orchestrate completion via polling or webhooks. Polling configuration can use
+  a custom delay implementation for durable workflow compatibility.
+
 ## 4.0.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -7354,6 +7354,125 @@ type VideoModelV4Result = {
     };
 };
 
+/**
+ * Result returned by `doStart` when initiating an asynchronous video generation.
+ */
+type VideoModelV4OperationStartResult = {
+    /**
+     * JSON-serializable opaque reference passed to `doStatus` to check the
+     * status of the generation (e.g., a task ID or prediction URL).
+     */
+    operation: JSONValue;
+    /**
+     * Warnings for the call, e.g. unsupported features.
+     */
+    warnings: Array<SharedV4Warning>;
+    /**
+     * Additional provider-specific metadata.
+     */
+    providerMetadata?: SharedV4ProviderMetadata;
+    /**
+     * Response information for telemetry and debugging purposes.
+     */
+    response: {
+        /**
+         * Timestamp for the start of the response.
+         */
+        timestamp: Date;
+        /**
+         * The ID of the response model that was used.
+         */
+        modelId: string;
+        /**
+         * Response headers.
+         */
+        headers: Record<string, string> | undefined;
+    };
+};
+
+/**
+ * Result returned by `doStatus` when checking the status of an
+ * asynchronous video generation.
+ */
+type VideoModelV4OperationStatusResult = {
+    /**
+     * The video generation is still in progress.
+     */
+    status: 'pending';
+    /**
+     * Warnings for the call.
+     */
+    warnings?: Array<SharedV4Warning>;
+    /**
+     * Additional provider-specific metadata.
+     */
+    providerMetadata?: SharedV4ProviderMetadata;
+    /**
+     * Response information for telemetry and debugging purposes.
+     */
+    response: {
+        timestamp: Date;
+        modelId: string;
+        headers: Record<string, string> | undefined;
+    };
+} | {
+    /**
+     * The video generation is complete.
+     */
+    status: 'completed';
+    /**
+     * Generated videos.
+     */
+    videos: Array<VideoModelV4VideoData>;
+    /**
+     * Warnings for the call.
+     */
+    warnings: Array<SharedV4Warning>;
+    /**
+     * Additional provider-specific metadata.
+     */
+    providerMetadata?: SharedV4ProviderMetadata;
+    /**
+     * Response information for telemetry and debugging purposes.
+     */
+    response: {
+        timestamp: Date;
+        modelId: string;
+        headers: Record<string, string> | undefined;
+    };
+} | {
+    /**
+     * The video generation failed.
+     */
+    status: 'error';
+    /**
+     * A human-readable error message describing why the generation failed.
+     */
+    error: string;
+    /**
+     * Additional provider-specific metadata.
+     */
+    providerMetadata?: SharedV4ProviderMetadata;
+    /**
+     * Response information for telemetry and debugging purposes.
+     */
+    response: {
+        timestamp: Date;
+        modelId: string;
+        headers: Record<string, string> | undefined;
+    };
+};
+
+/**
+ * Data received from a webhook notification during asynchronous video
+ * generation. Generic over the body type so providers/consumers can
+ * narrow it to a specific shape.
+ */
+type VideoModelV4OperationWebhook<TBody = JSONValue> = {
+    headers: Record<string, string>;
+    body: TBody;
+};
+
 type GetMaxVideosPerCallFunction$1 = (options: {
     modelId: string;
 }) => PromiseLike<number | undefined> | number | undefined;
@@ -7389,8 +7508,80 @@ type VideoModelV4 = {
     readonly maxVideosPerCall: number | undefined | GetMaxVideosPerCallFunction$1;
     /**
      * Generates an array of videos.
+     *
+     * Optional when `doStart` and `doStatus` are provided to support
+     * the asynchronous start/status flow.
+     */
+    doGenerate?(options: VideoModelV4CallOptions): PromiseLike<VideoModelV4Result>;
+    /**
+     * Optional method that handles the user's `webhook` option for the
+     * asynchronous start/status flow.
+     *
+     * Its presence on the model signals that the provider's API natively
+     * supports webhooks. The SDK checks for this method before invoking the
+     * user-provided `webhook` factory:
+     *
+     * - **Present**: The SDK calls this method with the user's webhook factory.
+     *   The implementation should invoke the factory to obtain a webhook URL
+     *   and a `received` promise. The URL is then forwarded to `doStart` via
+     *   `webhookUrl`, and the SDK awaits `received` instead of polling.
+     *
+     * - **Absent**: The SDK never calls the user's `webhook` factory and falls
+     *   back to polling via `doStatus`. This avoids unnecessary webhook
+     *   endpoint creation for providers whose APIs have no native webhook
+     *   mechanism.
+     *
+     * This method exists because the SDK must decide whether to invoke the
+     * user's webhook factory — which may create real HTTP endpoints or
+     * external resources — *before* calling `doStart`. Without an explicit
+     * capability signal on the model, the SDK would eagerly create a webhook
+     * endpoint for every provider, even those that silently ignore the URL.
+     */
+    handleWebhookOption?: (options: {
+        webhook: () => PromiseLike<{
+            url: string;
+            received: PromiseLike<VideoModelV4OperationWebhook>;
+        }>;
+    }) => PromiseLike<{
+        webhookUrl: string;
+        received: PromiseLike<VideoModelV4OperationWebhook>;
+    }>;
+    /**
+     * Starts an asynchronous video generation and returns an opaque operation
+     * reference that can be passed to `doStatus` to poll for completion.
+     *
+     * When both `doStart` and `doStatus` are implemented, the SDK core can
+     * orchestrate polling or webhook-based completion instead of requiring
+     * the provider to implement its own polling loop in `doGenerate`.
      */
-    doGenerate(options: VideoModelV4CallOptions): PromiseLike<VideoModelV4Result>;
+    doStart?(options: VideoModelV4CallOptions & {
+        /**
+         * When provided, the provider should register this URL to receive
+         * a webhook notification when the video generation completes.
+         */
+        webhookUrl?: string;
+    }): PromiseLike<VideoModelV4OperationStartResult>;
+    /**
+     * Checks the status of an asynchronous video generation that was
+     * started with `doStart`.
+     *
+     * Returns either a `pending` status or a `completed` status with the
+     * generated videos.
+     */
+    doStatus?(options: {
+        /**
+         * The JSON-serializable opaque operation reference returned by `doStart`.
+         */
+        operation: JSONValue;
+        /**
+         * Abort signal for cancelling the operation.
+         */
+        abortSignal?: AbortSignal;
+        /**
+         * Additional HTTP headers.
+         */
+        headers?: Record<string, string | undefined>;
+    }): PromiseLike<VideoModelV4OperationStatusResult>;
 };
 
 /**
@@ -7648,4 +7839,4 @@ type VideoModelV3 = {
     }>;
 };
 
-export { AISDKError, APICallError, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3CallOptions, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, type EmbeddingModelV3Result, type EmbeddingModelV4, type EmbeddingModelV4CallOptions, type EmbeddingModelV4Embedding, type EmbeddingModelV4Middleware, type EmbeddingModelV4Result, EmptyResponseBodyError, type RealtimeFactoryV4 as Experimental_RealtimeFactoryV4, type RealtimeFactoryV4GetTokenOptions as Experimental_RealtimeFactoryV4GetTokenOptions, type RealtimeFactoryV4GetTokenResult as Experimental_RealtimeFactoryV4GetTokenResult, type RealtimeModelV4 as Experimental_RealtimeModelV4, type RealtimeModelV4AudioMessage as Experimental_RealtimeModelV4AudioMessage, type RealtimeModelV4ClientEvent as Experimental_RealtimeModelV4ClientEvent, type RealtimeModelV4ClientSecretOptions as Experimental_RealtimeModelV4ClientSecretOptions, type RealtimeModelV4ClientSecretResult as Experimental_RealtimeModelV4ClientSecretResult, type RealtimeModelV4ConversationItem as Experimental_RealtimeModelV4ConversationItem, type RealtimeModelV4FunctionCallOutput as Experimental_RealtimeModelV4FunctionCallOutput, type RealtimeModelV4ServerEvent as Experimental_RealtimeModelV4ServerEvent, type RealtimeModelV4SessionConfig as Experimental_RealtimeModelV4SessionConfig, type RealtimeModelV4TextMessage as Experimental_RealtimeModelV4TextMessage, type RealtimeModelV4ToolDefinition as Experimental_RealtimeModelV4ToolDefinition, type SpeechTranslationModelV4 as Experimental_SpeechTranslationModelV4, type SpeechTranslationModelV4StreamOptions as Experimental_SpeechTranslationModelV4StreamOptions, type SpeechTranslationModelV4StreamPart as Experimental_SpeechTranslationModelV4StreamPart, type SpeechTranslationModelV4StreamResult as Experimental_SpeechTranslationModelV4StreamResult, type SpeechTranslationModelV4Usage as Experimental_SpeechTranslationModelV4Usage, type TranscriptionModelV4StreamOptions as Experimental_TranscriptionModelV4StreamOptions, type TranscriptionModelV4StreamPart as Experimental_TranscriptionModelV4StreamPart, type TranscriptionModelV4StreamResult as Experimental_TranscriptionModelV4StreamResult, type VideoModelV3 as Experimental_VideoModelV3, type VideoModelV3CallOptions as Experimental_VideoModelV3CallOptions, type VideoModelV3File as Experimental_VideoModelV3File, type VideoModelV3FrameImage as Experimental_VideoModelV3FrameImage, type VideoModelV3FrameType as Experimental_VideoModelV3FrameType, type VideoModelV3VideoData as Experimental_VideoModelV3VideoData, type VideoModelV4 as Experimental_VideoModelV4, type VideoModelV4CallOptions as Experimental_VideoModelV4CallOptions, type VideoModelV4File as Experimental_VideoModelV4File, type VideoModelV4FrameImage as Experimental_VideoModelV4FrameImage, type VideoModelV4FrameType as Experimental_VideoModelV4FrameType, type VideoModelV4Result as Experimental_VideoModelV4Result, type VideoModelV4VideoData as Experimental_VideoModelV4VideoData, type FilesV4, type FilesV4UploadFileCallOptions, type FilesV4UploadFileResult, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3File, type ImageModelV3Middleware, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, type ImageModelV4, type ImageModelV4CallOptions, type ImageModelV4File, type ImageModelV4Middleware, type ImageModelV4ProviderMetadata, type ImageModelV4Result, type ImageModelV4Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3GenerateResult, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3StreamResult, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolApprovalRequest, type LanguageModelV3ToolApprovalResponsePart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, type LanguageModelV4, type LanguageModelV4CallOptions, type LanguageModelV4Content, type LanguageModelV4CustomContent, type LanguageModelV4CustomPart, type LanguageModelV4File, type LanguageModelV4FilePart, type LanguageModelV4FinishReason, type LanguageModelV4FunctionTool, type LanguageModelV4GenerateResult, type LanguageModelV4Message, type LanguageModelV4Middleware, type LanguageModelV4Prompt, type LanguageModelV4ProviderTool, type LanguageModelV4Reasoning, type LanguageModelV4ReasoningFile, type LanguageModelV4ReasoningFilePart, type LanguageModelV4ReasoningPart, type LanguageModelV4ResponseMetadata, type LanguageModelV4Source, type LanguageModelV4StreamPart, type LanguageModelV4StreamResult, type LanguageModelV4Text, type LanguageModelV4TextPart, type LanguageModelV4ToolApprovalRequest, type LanguageModelV4ToolApprovalResponsePart, type LanguageModelV4ToolCall, type LanguageModelV4ToolCallPart, type LanguageModelV4ToolChoice, type LanguageModelV4ToolResult, type LanguageModelV4ToolResultOutput, type LanguageModelV4ToolResultPart, type LanguageModelV4Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, NoSuchProviderReferenceError, type ProviderV2, type ProviderV3, type ProviderV4, type RerankingModelV3, type RerankingModelV3CallOptions, type RerankingModelV4, type RerankingModelV4CallOptions, type RerankingModelV4Result, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SharedV4AudioFormat, type SharedV4FileData, type SharedV4FileDataData, type SharedV4FileDataReference, type SharedV4FileDataText, type SharedV4FileDataUrl, type SharedV4Headers, type SharedV4ProviderMetadata, type SharedV4ProviderOptions, type SharedV4ProviderReference, type SharedV4Warning, type SkillsV4, type SkillsV4File, type SkillsV4UploadSkillCallOptions, type SkillsV4UploadSkillResult, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, type SpeechModelV4, type SpeechModelV4CallOptions, type SpeechModelV4Result, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, type TranscriptionModelV4, type TranscriptionModelV4CallOptions, type TranscriptionModelV4Result, type TypeValidationContext, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3CallOptions, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, type EmbeddingModelV3Result, type EmbeddingModelV4, type EmbeddingModelV4CallOptions, type EmbeddingModelV4Embedding, type EmbeddingModelV4Middleware, type EmbeddingModelV4Result, EmptyResponseBodyError, type RealtimeFactoryV4 as Experimental_RealtimeFactoryV4, type RealtimeFactoryV4GetTokenOptions as Experimental_RealtimeFactoryV4GetTokenOptions, type RealtimeFactoryV4GetTokenResult as Experimental_RealtimeFactoryV4GetTokenResult, type RealtimeModelV4 as Experimental_RealtimeModelV4, type RealtimeModelV4AudioMessage as Experimental_RealtimeModelV4AudioMessage, type RealtimeModelV4ClientEvent as Experimental_RealtimeModelV4ClientEvent, type RealtimeModelV4ClientSecretOptions as Experimental_RealtimeModelV4ClientSecretOptions, type RealtimeModelV4ClientSecretResult as Experimental_RealtimeModelV4ClientSecretResult, type RealtimeModelV4ConversationItem as Experimental_RealtimeModelV4ConversationItem, type RealtimeModelV4FunctionCallOutput as Experimental_RealtimeModelV4FunctionCallOutput, type RealtimeModelV4ServerEvent as Experimental_RealtimeModelV4ServerEvent, type RealtimeModelV4SessionConfig as Experimental_RealtimeModelV4SessionConfig, type RealtimeModelV4TextMessage as Experimental_RealtimeModelV4TextMessage, type RealtimeModelV4ToolDefinition as Experimental_RealtimeModelV4ToolDefinition, type SpeechTranslationModelV4 as Experimental_SpeechTranslationModelV4, type SpeechTranslationModelV4StreamOptions as Experimental_SpeechTranslationModelV4StreamOptions, type SpeechTranslationModelV4StreamPart as Experimental_SpeechTranslationModelV4StreamPart, type SpeechTranslationModelV4StreamResult as Experimental_SpeechTranslationModelV4StreamResult, type SpeechTranslationModelV4Usage as Experimental_SpeechTranslationModelV4Usage, type TranscriptionModelV4StreamOptions as Experimental_TranscriptionModelV4StreamOptions, type TranscriptionModelV4StreamPart as Experimental_TranscriptionModelV4StreamPart, type TranscriptionModelV4StreamResult as Experimental_TranscriptionModelV4StreamResult, type VideoModelV3 as Experimental_VideoModelV3, type VideoModelV3CallOptions as Experimental_VideoModelV3CallOptions, type VideoModelV3File as Experimental_VideoModelV3File, type VideoModelV3FrameImage as Experimental_VideoModelV3FrameImage, type VideoModelV3FrameType as Experimental_VideoModelV3FrameType, type VideoModelV3VideoData as Experimental_VideoModelV3VideoData, type VideoModelV4 as Experimental_VideoModelV4, type VideoModelV4CallOptions as Experimental_VideoModelV4CallOptions, type VideoModelV4File as Experimental_VideoModelV4File, type VideoModelV4FrameImage as Experimental_VideoModelV4FrameImage, type VideoModelV4FrameType as Experimental_VideoModelV4FrameType, type VideoModelV4OperationStartResult as Experimental_VideoModelV4OperationStartResult, type VideoModelV4OperationStatusResult as Experimental_VideoModelV4OperationStatusResult, type VideoModelV4OperationWebhook as Experimental_VideoModelV4OperationWebhook, type VideoModelV4Result as Experimental_VideoModelV4Result, type VideoModelV4VideoData as Experimental_VideoModelV4VideoData, type FilesV4, type FilesV4UploadFileCallOptions, type FilesV4UploadFileResult, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3File, type ImageModelV3Middleware, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, type ImageModelV4, type ImageModelV4CallOptions, type ImageModelV4File, type ImageModelV4Middleware, type ImageModelV4ProviderMetadata, type ImageModelV4Result, type ImageModelV4Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3GenerateResult, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3StreamResult, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolApprovalRequest, type LanguageModelV3ToolApprovalResponsePart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, type LanguageModelV4, type LanguageModelV4CallOptions, type LanguageModelV4Content, type LanguageModelV4CustomContent, type LanguageModelV4CustomPart, type LanguageModelV4File, type LanguageModelV4FilePart, type LanguageModelV4FinishReason, type LanguageModelV4FunctionTool, type LanguageModelV4GenerateResult, type LanguageModelV4Message, type LanguageModelV4Middleware, type LanguageModelV4Prompt, type LanguageModelV4ProviderTool, type LanguageModelV4Reasoning, type LanguageModelV4ReasoningFile, type LanguageModelV4ReasoningFilePart, type LanguageModelV4ReasoningPart, type LanguageModelV4ResponseMetadata, type LanguageModelV4Source, type LanguageModelV4StreamPart, type LanguageModelV4StreamResult, type LanguageModelV4Text, type LanguageModelV4TextPart, type LanguageModelV4ToolApprovalRequest, type LanguageModelV4ToolApprovalResponsePart, type LanguageModelV4ToolCall, type LanguageModelV4ToolCallPart, type LanguageModelV4ToolChoice, type LanguageModelV4ToolResult, type LanguageModelV4ToolResultOutput, type LanguageModelV4ToolResultPart, type LanguageModelV4Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, NoSuchProviderReferenceError, type ProviderV2, type ProviderV3, type ProviderV4, type RerankingModelV3, type RerankingModelV3CallOptions, type RerankingModelV4, type RerankingModelV4CallOptions, type RerankingModelV4Result, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SharedV4AudioFormat, type SharedV4FileData, type SharedV4FileDataData, type SharedV4FileDataReference, type SharedV4FileDataText, type SharedV4FileDataUrl, type SharedV4Headers, type SharedV4ProviderMetadata, type SharedV4ProviderOptions, type SharedV4ProviderReference, type SharedV4Warning, type SkillsV4, type SkillsV4File, type SkillsV4UploadSkillCallOptions, type SkillsV4UploadSkillResult, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, type SpeechModelV4, type SpeechModelV4CallOptions, type SpeechModelV4Result, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, type TranscriptionModelV4, type TranscriptionModelV4CallOptions, type TranscriptionModelV4Result, type TypeValidationContext, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider",
-  "version": "4.0.4",
+  "version": "4.0.5",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,

package/src/video-model/v4/index.ts

@@ -5,6 +5,9 @@ export type {
   VideoModelV4VideoData as Experimental_VideoModelV4VideoData,
 } from './video-model-v4-result';
 export type { VideoModelV4File as Experimental_VideoModelV4File } from './video-model-v4-file';
+export type { VideoModelV4OperationStartResult as Experimental_VideoModelV4OperationStartResult } from './video-model-v4-operation-start-result';
+export type { VideoModelV4OperationStatusResult as Experimental_VideoModelV4OperationStatusResult } from './video-model-v4-operation-status-result';
+export type { VideoModelV4OperationWebhook as Experimental_VideoModelV4OperationWebhook } from './video-model-v4-operation-webhook';
 export type {
   VideoModelV4FrameImage as Experimental_VideoModelV4FrameImage,
   VideoModelV4FrameType as Experimental_VideoModelV4FrameType,

package/src/video-model/v4/video-model-v4-operation-start-result.ts

@@ -0,0 +1,44 @@
+import type { JSONValue } from '../../json-value/json-value';
+import type { SharedV4ProviderMetadata } from '../../shared/v4/shared-v4-provider-metadata';
+import type { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
+
+/**
+ * Result returned by `doStart` when initiating an asynchronous video generation.
+ */
+export type VideoModelV4OperationStartResult = {
+  /**
+   * JSON-serializable opaque reference passed to `doStatus` to check the
+   * status of the generation (e.g., a task ID or prediction URL).
+   */
+  operation: JSONValue;
+
+  /**
+   * Warnings for the call, e.g. unsupported features.
+   */
+  warnings: Array<SharedV4Warning>;
+
+  /**
+   * Additional provider-specific metadata.
+   */
+  providerMetadata?: SharedV4ProviderMetadata;
+
+  /**
+   * Response information for telemetry and debugging purposes.
+   */
+  response: {
+    /**
+     * Timestamp for the start of the response.
+     */
+    timestamp: Date;
+
+    /**
+     * The ID of the response model that was used.
+     */
+    modelId: string;
+
+    /**
+     * Response headers.
+     */
+    headers: Record<string, string> | undefined;
+  };
+};

package/src/video-model/v4/video-model-v4-operation-status-result.ts

@@ -0,0 +1,89 @@
+import type { SharedV4ProviderMetadata } from '../../shared/v4/shared-v4-provider-metadata';
+import type { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
+import type { VideoModelV4VideoData } from './video-model-v4-result';
+
+/**
+ * Result returned by `doStatus` when checking the status of an
+ * asynchronous video generation.
+ */
+export type VideoModelV4OperationStatusResult =
+  | {
+      /**
+       * The video generation is still in progress.
+       */
+      status: 'pending';
+
+      /**
+       * Warnings for the call.
+       */
+      warnings?: Array<SharedV4Warning>;
+
+      /**
+       * Additional provider-specific metadata.
+       */
+      providerMetadata?: SharedV4ProviderMetadata;
+
+      /**
+       * Response information for telemetry and debugging purposes.
+       */
+      response: {
+        timestamp: Date;
+        modelId: string;
+        headers: Record<string, string> | undefined;
+      };
+    }
+  | {
+      /**
+       * The video generation is complete.
+       */
+      status: 'completed';
+
+      /**
+       * Generated videos.
+       */
+      videos: Array<VideoModelV4VideoData>;
+
+      /**
+       * Warnings for the call.
+       */
+      warnings: Array<SharedV4Warning>;
+
+      /**
+       * Additional provider-specific metadata.
+       */
+      providerMetadata?: SharedV4ProviderMetadata;
+
+      /**
+       * Response information for telemetry and debugging purposes.
+       */
+      response: {
+        timestamp: Date;
+        modelId: string;
+        headers: Record<string, string> | undefined;
+      };
+    }
+  | {
+      /**
+       * The video generation failed.
+       */
+      status: 'error';
+
+      /**
+       * A human-readable error message describing why the generation failed.
+       */
+      error: string;
+
+      /**
+       * Additional provider-specific metadata.
+       */
+      providerMetadata?: SharedV4ProviderMetadata;
+
+      /**
+       * Response information for telemetry and debugging purposes.
+       */
+      response: {
+        timestamp: Date;
+        modelId: string;
+        headers: Record<string, string> | undefined;
+      };
+    };

package/src/video-model/v4/video-model-v4-operation-webhook.ts

@@ -0,0 +1,11 @@
+import type { JSONValue } from '../../json-value/json-value';
+
+/**
+ * Data received from a webhook notification during asynchronous video
+ * generation. Generic over the body type so providers/consumers can
+ * narrow it to a specific shape.
+ */
+export type VideoModelV4OperationWebhook<TBody = JSONValue> = {
+  headers: Record<string, string>;
+  body: TBody;
+};

package/src/video-model/v4/video-model-v4.ts

@@ -1,5 +1,9 @@
+import type { JSONValue } from '../../json-value/json-value';
 import type { VideoModelV4CallOptions } from './video-model-v4-call-options';
 import type { VideoModelV4Result } from './video-model-v4-result';
+import type { VideoModelV4OperationStartResult } from './video-model-v4-operation-start-result';
+import type { VideoModelV4OperationStatusResult } from './video-model-v4-operation-status-result';
+import type { VideoModelV4OperationWebhook } from './video-model-v4-operation-webhook';
 
 type GetMaxVideosPerCallFunction = (options: {
   modelId: string;
@@ -41,6 +45,87 @@ export type VideoModelV4 = {
 
   /**
    * Generates an array of videos.
+   *
+   * Optional when `doStart` and `doStatus` are provided to support
+   * the asynchronous start/status flow.
+   */
+  doGenerate?(
+    options: VideoModelV4CallOptions,
+  ): PromiseLike<VideoModelV4Result>;
+
+  /**
+   * Optional method that handles the user's `webhook` option for the
+   * asynchronous start/status flow.
+   *
+   * Its presence on the model signals that the provider's API natively
+   * supports webhooks. The SDK checks for this method before invoking the
+   * user-provided `webhook` factory:
+   *
+   * - **Present**: The SDK calls this method with the user's webhook factory.
+   *   The implementation should invoke the factory to obtain a webhook URL
+   *   and a `received` promise. The URL is then forwarded to `doStart` via
+   *   `webhookUrl`, and the SDK awaits `received` instead of polling.
+   *
+   * - **Absent**: The SDK never calls the user's `webhook` factory and falls
+   *   back to polling via `doStatus`. This avoids unnecessary webhook
+   *   endpoint creation for providers whose APIs have no native webhook
+   *   mechanism.
+   *
+   * This method exists because the SDK must decide whether to invoke the
+   * user's webhook factory — which may create real HTTP endpoints or
+   * external resources — *before* calling `doStart`. Without an explicit
+   * capability signal on the model, the SDK would eagerly create a webhook
+   * endpoint for every provider, even those that silently ignore the URL.
+   */
+  handleWebhookOption?: (options: {
+    webhook: () => PromiseLike<{
+      url: string;
+      received: PromiseLike<VideoModelV4OperationWebhook>;
+    }>;
+  }) => PromiseLike<{
+    webhookUrl: string;
+    received: PromiseLike<VideoModelV4OperationWebhook>;
+  }>;
+
+  /**
+   * Starts an asynchronous video generation and returns an opaque operation
+   * reference that can be passed to `doStatus` to poll for completion.
+   *
+   * When both `doStart` and `doStatus` are implemented, the SDK core can
+   * orchestrate polling or webhook-based completion instead of requiring
+   * the provider to implement its own polling loop in `doGenerate`.
    */
-  doGenerate(options: VideoModelV4CallOptions): PromiseLike<VideoModelV4Result>;
+  doStart?(
+    options: VideoModelV4CallOptions & {
+      /**
+       * When provided, the provider should register this URL to receive
+       * a webhook notification when the video generation completes.
+       */
+      webhookUrl?: string;
+    },
+  ): PromiseLike<VideoModelV4OperationStartResult>;
+
+  /**
+   * Checks the status of an asynchronous video generation that was
+   * started with `doStart`.
+   *
+   * Returns either a `pending` status or a `completed` status with the
+   * generated videos.
+   */
+  doStatus?(options: {
+    /**
+     * The JSON-serializable opaque operation reference returned by `doStart`.
+     */
+    operation: JSONValue;
+
+    /**
+     * Abort signal for cancelling the operation.
+     */
+    abortSignal?: AbortSignal;
+
+    /**
+     * Additional HTTP headers.
+     */
+    headers?: Record<string, string | undefined>;
+  }): PromiseLike<VideoModelV4OperationStatusResult>;
 };