@ai-sdk/klingai 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/klingai
 
+## 3.0.2
+
+### Patch Changes
+
+- 99fbed8: feat: normalize provider specific model options type names and ensure they are exported
+
+## 3.0.1
+
+### Patch Changes
+
+- c43aeb2: feat (provider/klingai): add text-to-video and image-to-video support
+
 ## 3.0.0
 
 ### Major Changes

package/README.md

@@ -26,33 +26,73 @@ You can import the default provider instance `klingai` from `@ai-sdk/klingai`:
 import { klingai } from '@ai-sdk/klingai';
 ```
 
-## Video Generation Example
+## Video Models
+
+This provider currently supports three video generation modes: text-to-video, image-to-video, and motion control.
+
+> **Note:** Not all options are supported by every model version and mode combination. See the [KlingAI Capability Map](https://app.klingai.com/global/dev/document-api/apiReference/model/skillsMap) for detailed compatibility.
+
+### Text-to-Video
+
+Generate video from a text prompt.
+
+Available models: `kling-v1-t2v`, `kling-v1.6-t2v`, `kling-v2-master-t2v`, `kling-v2.1-master-t2v`, `kling-v2.5-turbo-t2v`, `kling-v2.6-t2v`
 
 ```ts
 import { klingai } from '@ai-sdk/klingai';
 import { experimental_generateVideo } from 'ai';
 
 const { videos } = await experimental_generateVideo({
-  model: klingai.video('kling-v2.6-motion-control'),
+  model: klingai.video('kling-v2.6-t2v'),
+  prompt: 'A chicken flying into the sunset in the style of 90s anime.',
+  aspectRatio: '16:9',
+  duration: 5,
+  providerOptions: {
+    klingai: {
+      mode: 'std',
+    },
+  },
+});
+```
+
+### Image-to-Video
+
+Generate video from a start frame image, with optional end frame control.
+
+Available models: `kling-v1-i2v`, `kling-v1.5-i2v`, `kling-v1.6-i2v`, `kling-v2-master-i2v`, `kling-v2.1-i2v`, `kling-v2.1-master-i2v`, `kling-v2.5-turbo-i2v`, `kling-v2.6-i2v`
+
+```ts
+import { klingai } from '@ai-sdk/klingai';
+import { experimental_generateVideo } from 'ai';
+
+const { videos } = await experimental_generateVideo({
+  model: klingai.video('kling-v2.6-i2v'),
   prompt: {
-    image: 'https://example.com/character.png',
-    text: 'The character performs a smooth dance move',
+    image: 'https://example.com/start-frame.png',
+    text: 'The cat slowly turns its head and blinks',
   },
+  duration: 5,
   providerOptions: {
     klingai: {
-      videoUrl: 'https://example.com/reference-motion.mp4',
-      characterOrientation: 'image',
-      mode: 'std',
+      // Pro mode required for start+end frame control
+      mode: 'pro',
+      // Optional: end frame image
+      imageTail: 'https://example.com/end-frame.png',
     },
   },
 });
 ```
 
-## Additional Options
+### Motion Control
+
+Generate video using a reference motion video.
 
-Use `providerOptions.klingai` to configure motion control options:
+Available models: `kling-v2.6-motion-control`
 
 ```ts
+import { klingai } from '@ai-sdk/klingai';
+import { experimental_generateVideo } from 'ai';
+
 const { videos } = await experimental_generateVideo({
   model: klingai.video('kling-v2.6-motion-control'),
   prompt: {
@@ -62,17 +102,36 @@ const { videos } = await experimental_generateVideo({
   providerOptions: {
     klingai: {
       videoUrl: 'https://example.com/reference-motion.mp4',
-      characterOrientation: 'video',
-      mode: 'pro',
-      keepOriginalSound: 'yes',
-      watermarkEnabled: true,
-      pollIntervalMs: 10000,
-      pollTimeoutMs: 600000,
+      characterOrientation: 'image',
+      mode: 'std',
     },
   },
 });
 ```
 
+## Provider Options
+
+Use `providerOptions.klingai` to configure video generation. Options vary by mode:
+
+| Option                 | T2V               | I2V               | Motion Control    | Description                     |
+| ---------------------- | ----------------- | ----------------- | ----------------- | ------------------------------- |
+| `mode`                 | `'std'` / `'pro'` | `'std'` / `'pro'` | `'std'` / `'pro'` | Generation quality mode         |
+| `negativePrompt`       | Yes               | Yes               | —                 | What to avoid (max 2500 chars)  |
+| `sound`                | V2.6+ pro only    | V2.6+ pro only    | —                 | `'on'` / `'off'` for audio      |
+| `cfgScale`             | Yes (V1.x)        | Yes (V1.x)        | —                 | Prompt adherence [0, 1]         |
+| `cameraControl`        | Yes               | Yes               | —                 | Camera movement presets         |
+| `imageTail`            | —                 | Pro mode          | —                 | End frame image (URL or base64) |
+| `staticMask`           | —                 | Yes               | —                 | Static brush mask               |
+| `dynamicMasks`         | —                 | Yes               | —                 | Dynamic brush configs           |
+| `videoUrl`             | —                 | —                 | Required          | Reference motion video URL      |
+| `characterOrientation` | —                 | —                 | Required          | `'image'` or `'video'`          |
+| `keepOriginalSound`    | —                 | —                 | Yes               | `'yes'` / `'no'`                |
+| `watermarkEnabled`     | —                 | —                 | Yes               | Enable watermark                |
+| `pollIntervalMs`       | Yes               | Yes               | Yes               | Poll interval (default: 5000ms) |
+| `pollTimeoutMs`        | Yes               | Yes               | Yes               | Max wait (default: 600000ms)    |
+
+See the [KlingAI Capability Map](https://app.klingai.com/global/dev/document-api/apiReference/model/skillsMap) for which features each model version supports.
+
 ## Authentication
 
 Kling AI uses access key / secret key authentication. Set the following environment variables:

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { ProviderV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
-type KlingAIVideoModelId = 'kling-v2.6-motion-control' | (string & {});
+type KlingAIVideoModelId = 'kling-v1-t2v' | 'kling-v1.6-t2v' | 'kling-v2-master-t2v' | 'kling-v2.1-master-t2v' | 'kling-v2.5-turbo-t2v' | 'kling-v2.6-t2v' | 'kling-v1-i2v' | 'kling-v1.5-i2v' | 'kling-v1.6-i2v' | 'kling-v2-master-i2v' | 'kling-v2.1-i2v' | 'kling-v2.1-master-i2v' | 'kling-v2.5-turbo-i2v' | 'kling-v2.6-i2v' | 'kling-v2.6-motion-control' | (string & {});
 
 interface KlingAIProviderSettings {
     /**
@@ -47,7 +47,85 @@ declare function createKlingAI(options?: KlingAIProviderSettings): KlingAIProvid
  */
 declare const klingai: KlingAIProvider;
 
-type KlingAIVideoProviderOptions = {
+/**
+ * Provider-specific options for KlingAI video generation.
+ *
+ * Not all options are supported by every model version and video mode (T2V, I2V,
+ * motion control). See the KlingAI capability map for detailed compatibility:
+ * https://app.klingai.com/global/dev/document-api/apiReference/model/skillsMap
+ */
+type KlingAIVideoModelOptions = {
+    /**
+     * Video generation mode.
+     *
+     * - `'std'`: Standard mode — cost-effective.
+     * - `'pro'`: Professional mode — higher quality but longer generation time.
+     */
+    mode?: 'std' | 'pro' | null;
+    /**
+     * Polling interval in milliseconds for checking task status.
+     * Default: 5000 (5 seconds).
+     */
+    pollIntervalMs?: number | null;
+    /**
+     * Maximum time in milliseconds to wait for video generation.
+     * Default: 600000 (10 minutes).
+     */
+    pollTimeoutMs?: number | null;
+    /**
+     * Negative text prompt to specify what to avoid.
+     * Cannot exceed 2500 characters.
+     */
+    negativePrompt?: string | null;
+    /**
+     * Whether to generate sound simultaneously when generating videos.
+     * Only V2.6 and subsequent versions support this parameter,
+     * and requires `mode: 'pro'`.
+     */
+    sound?: 'on' | 'off' | null;
+    /**
+     * Flexibility in video generation. The higher the value, the lower the
+     * model's flexibility, and the stronger the relevance to the user's prompt.
+     * Value range: [0, 1]. Kling-v2.x models do not support this parameter.
+     */
+    cfgScale?: number | null;
+    /**
+     * Camera movement control. If not specified, the model will intelligently
+     * match based on the input text/images.
+     */
+    cameraControl?: {
+        type: 'simple' | 'down_back' | 'forward_up' | 'right_turn_forward' | 'left_turn_forward';
+        config?: {
+            horizontal?: number | null;
+            vertical?: number | null;
+            pan?: number | null;
+            tilt?: number | null;
+            roll?: number | null;
+            zoom?: number | null;
+        } | null;
+    } | null;
+    /**
+     * End frame image for I2V start+end frame control.
+     * Supports image URL or raw base64-encoded image data.
+     * Requires `mode: 'pro'` for most models.
+     */
+    imageTail?: string | null;
+    /**
+     * Static brush mask image for I2V motion brush.
+     * Supports image URL or raw base64-encoded image data.
+     */
+    staticMask?: string | null;
+    /**
+     * Dynamic brush configurations for I2V motion brush.
+     * Up to 6 groups, each with a mask and motion trajectories.
+     */
+    dynamicMasks?: Array<{
+        mask: string;
+        trajectories: Array<{
+            x: number;
+            y: number;
+        }>;
+    }> | null;
     /**
      * URL of the reference video. The character actions in the generated video
      * are consistent with the reference video.
@@ -55,7 +133,7 @@ type KlingAIVideoProviderOptions = {
      * Supports .mp4/.mov, max 100MB, side lengths 340px–3850px,
      * duration 3–30 seconds (depends on `characterOrientation`).
      */
-    videoUrl: string;
+    videoUrl?: string | null;
     /**
      * Orientation of the characters in the generated video.
      *
@@ -64,14 +142,7 @@ type KlingAIVideoProviderOptions = {
      * - `'video'`: Same orientation as the person in the video.
      *   Reference video duration max 30 seconds.
      */
-    characterOrientation: 'image' | 'video';
-    /**
-     * Video generation mode.
-     *
-     * - `'std'`: Standard mode — cost-effective.
-     * - `'pro'`: Professional mode — higher quality but longer generation time.
-     */
-    mode: 'std' | 'pro';
+    characterOrientation?: 'image' | 'video' | null;
     /**
      * Whether to keep the original sound of the reference video.
      * Default: `'yes'`.
@@ -81,17 +152,7 @@ type KlingAIVideoProviderOptions = {
      * Whether to generate watermarked results simultaneously.
      */
     watermarkEnabled?: boolean | null;
-    /**
-     * Polling interval in milliseconds for checking task status.
-     * Default: 5000 (5 seconds).
-     */
-    pollIntervalMs?: number | null;
-    /**
-     * Maximum time in milliseconds to wait for video generation.
-     * Default: 600000 (10 minutes).
-     */
-    pollTimeoutMs?: number | null;
     [key: string]: unknown;
 };
 
-export { type KlingAIProvider, type KlingAIProviderSettings, type KlingAIVideoModelId, type KlingAIVideoProviderOptions, createKlingAI, klingai };
+export { type KlingAIProvider, type KlingAIProviderSettings, type KlingAIVideoModelId, type KlingAIVideoModelOptions, type KlingAIVideoModelOptions as KlingAIVideoProviderOptions, createKlingAI, klingai };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ProviderV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
-type KlingAIVideoModelId = 'kling-v2.6-motion-control' | (string & {});
+type KlingAIVideoModelId = 'kling-v1-t2v' | 'kling-v1.6-t2v' | 'kling-v2-master-t2v' | 'kling-v2.1-master-t2v' | 'kling-v2.5-turbo-t2v' | 'kling-v2.6-t2v' | 'kling-v1-i2v' | 'kling-v1.5-i2v' | 'kling-v1.6-i2v' | 'kling-v2-master-i2v' | 'kling-v2.1-i2v' | 'kling-v2.1-master-i2v' | 'kling-v2.5-turbo-i2v' | 'kling-v2.6-i2v' | 'kling-v2.6-motion-control' | (string & {});
 
 interface KlingAIProviderSettings {
     /**
@@ -47,7 +47,85 @@ declare function createKlingAI(options?: KlingAIProviderSettings): KlingAIProvid
  */
 declare const klingai: KlingAIProvider;
 
-type KlingAIVideoProviderOptions = {
+/**
+ * Provider-specific options for KlingAI video generation.
+ *
+ * Not all options are supported by every model version and video mode (T2V, I2V,
+ * motion control). See the KlingAI capability map for detailed compatibility:
+ * https://app.klingai.com/global/dev/document-api/apiReference/model/skillsMap
+ */
+type KlingAIVideoModelOptions = {
+    /**
+     * Video generation mode.
+     *
+     * - `'std'`: Standard mode — cost-effective.
+     * - `'pro'`: Professional mode — higher quality but longer generation time.
+     */
+    mode?: 'std' | 'pro' | null;
+    /**
+     * Polling interval in milliseconds for checking task status.
+     * Default: 5000 (5 seconds).
+     */
+    pollIntervalMs?: number | null;
+    /**
+     * Maximum time in milliseconds to wait for video generation.
+     * Default: 600000 (10 minutes).
+     */
+    pollTimeoutMs?: number | null;
+    /**
+     * Negative text prompt to specify what to avoid.
+     * Cannot exceed 2500 characters.
+     */
+    negativePrompt?: string | null;
+    /**
+     * Whether to generate sound simultaneously when generating videos.
+     * Only V2.6 and subsequent versions support this parameter,
+     * and requires `mode: 'pro'`.
+     */
+    sound?: 'on' | 'off' | null;
+    /**
+     * Flexibility in video generation. The higher the value, the lower the
+     * model's flexibility, and the stronger the relevance to the user's prompt.
+     * Value range: [0, 1]. Kling-v2.x models do not support this parameter.
+     */
+    cfgScale?: number | null;
+    /**
+     * Camera movement control. If not specified, the model will intelligently
+     * match based on the input text/images.
+     */
+    cameraControl?: {
+        type: 'simple' | 'down_back' | 'forward_up' | 'right_turn_forward' | 'left_turn_forward';
+        config?: {
+            horizontal?: number | null;
+            vertical?: number | null;
+            pan?: number | null;
+            tilt?: number | null;
+            roll?: number | null;
+            zoom?: number | null;
+        } | null;
+    } | null;
+    /**
+     * End frame image for I2V start+end frame control.
+     * Supports image URL or raw base64-encoded image data.
+     * Requires `mode: 'pro'` for most models.
+     */
+    imageTail?: string | null;
+    /**
+     * Static brush mask image for I2V motion brush.
+     * Supports image URL or raw base64-encoded image data.
+     */
+    staticMask?: string | null;
+    /**
+     * Dynamic brush configurations for I2V motion brush.
+     * Up to 6 groups, each with a mask and motion trajectories.
+     */
+    dynamicMasks?: Array<{
+        mask: string;
+        trajectories: Array<{
+            x: number;
+            y: number;
+        }>;
+    }> | null;
     /**
      * URL of the reference video. The character actions in the generated video
      * are consistent with the reference video.
@@ -55,7 +133,7 @@ type KlingAIVideoProviderOptions = {
      * Supports .mp4/.mov, max 100MB, side lengths 340px–3850px,
      * duration 3–30 seconds (depends on `characterOrientation`).
      */
-    videoUrl: string;
+    videoUrl?: string | null;
     /**
      * Orientation of the characters in the generated video.
      *
@@ -64,14 +142,7 @@ type KlingAIVideoProviderOptions = {
      * - `'video'`: Same orientation as the person in the video.
      *   Reference video duration max 30 seconds.
      */
-    characterOrientation: 'image' | 'video';
-    /**
-     * Video generation mode.
-     *
-     * - `'std'`: Standard mode — cost-effective.
-     * - `'pro'`: Professional mode — higher quality but longer generation time.
-     */
-    mode: 'std' | 'pro';
+    characterOrientation?: 'image' | 'video' | null;
     /**
      * Whether to keep the original sound of the reference video.
      * Default: `'yes'`.
@@ -81,17 +152,7 @@ type KlingAIVideoProviderOptions = {
      * Whether to generate watermarked results simultaneously.
      */
     watermarkEnabled?: boolean | null;
-    /**
-     * Polling interval in milliseconds for checking task status.
-     * Default: 5000 (5 seconds).
-     */
-    pollIntervalMs?: number | null;
-    /**
-     * Maximum time in milliseconds to wait for video generation.
-     * Default: 600000 (10 minutes).
-     */
-    pollTimeoutMs?: number | null;
     [key: string]: unknown;
 };
 
-export { type KlingAIProvider, type KlingAIProviderSettings, type KlingAIVideoModelId, type KlingAIVideoProviderOptions, createKlingAI, klingai };
+export { type KlingAIProvider, type KlingAIProviderSettings, type KlingAIVideoModelId, type KlingAIVideoModelOptions, type KlingAIVideoModelOptions as KlingAIVideoProviderOptions, createKlingAI, klingai };