@ai-sdk/klingai 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ai-sdk/klingai
+
+## 3.0.0
+
+### Major Changes
+
+- cc12a89: feat (provider/klingai): initial klingai provider

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,98 @@
+# AI SDK - Kling AI Provider
+
+The **Kling AI provider** for the [AI SDK](https://ai-sdk.dev/docs) contains video model support for the [Kling AI API](https://app.klingai.com/global/dev/document-api/quickStart/productIntroduction/overview).
+
+## Setup
+
+The Kling AI provider is available in the `@ai-sdk/klingai` module. You can install it with:
+
+```bash
+npm i @ai-sdk/klingai
+```
+
+## Skill for Coding Agents
+
+If you use coding agents such as Claude Code or Cursor, we highly recommend adding the AI SDK skill to your repository:
+
+```shell
+npx skills add vercel/ai
+```
+
+## Provider Instance
+
+You can import the default provider instance `klingai` from `@ai-sdk/klingai`:
+
+```ts
+import { klingai } from '@ai-sdk/klingai';
+```
+
+## Video Generation Example
+
+```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: {
+    image: 'https://example.com/character.png',
+    text: 'The character performs a smooth dance move',
+  },
+  providerOptions: {
+    klingai: {
+      videoUrl: 'https://example.com/reference-motion.mp4',
+      characterOrientation: 'image',
+      mode: 'std',
+    },
+  },
+});
+```
+
+## Additional Options
+
+Use `providerOptions.klingai` to configure motion control options:
+
+```ts
+const { videos } = await experimental_generateVideo({
+  model: klingai.video('kling-v2.6-motion-control'),
+  prompt: {
+    image: 'https://example.com/character.png',
+    text: 'The character performs a smooth dance move',
+  },
+  providerOptions: {
+    klingai: {
+      videoUrl: 'https://example.com/reference-motion.mp4',
+      characterOrientation: 'video',
+      mode: 'pro',
+      keepOriginalSound: 'yes',
+      watermarkEnabled: true,
+      pollIntervalMs: 10000,
+      pollTimeoutMs: 600000,
+    },
+  },
+});
+```
+
+## Authentication
+
+Kling AI uses access key / secret key authentication. Set the following environment variables:
+
+```
+KLINGAI_ACCESS_KEY=your-access-key
+KLINGAI_SECRET_KEY=your-secret-key
+```
+
+Or pass them directly:
+
+```ts
+import { createKlingAI } from '@ai-sdk/klingai';
+
+const klingai = createKlingAI({
+  accessKey: 'your-access-key',
+  secretKey: 'your-secret-key',
+});
+```
+
+## Documentation
+
+Please check out the [Kling AI API documentation](https://app.klingai.com/global/dev/document-api/quickStart/productIntroduction/overview) for more information.

package/dist/index.d.mts

@@ -0,0 +1,97 @@
+import { ProviderV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+type KlingAIVideoModelId = 'kling-v2.6-motion-control' | (string & {});
+
+interface KlingAIProviderSettings {
+    /**
+     * KlingAI Access key. Default value is taken from the `KLINGAI_ACCESS_KEY`
+     * environment variable.
+     */
+    accessKey?: string;
+    /**
+     * KlingAI Secret key. Default value is taken from the `KLINGAI_SECRET_KEY`
+     * environment variable.
+     */
+    secretKey?: string;
+    /**
+     * Base URL for the API calls.
+     */
+    baseURL?: string;
+    /**
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom fetch implementation. You can use it as a middleware to intercept
+     * requests, or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+}
+interface KlingAIProvider extends ProviderV3 {
+    /**
+     * Creates a model for video generation.
+     */
+    video(modelId: KlingAIVideoModelId): Experimental_VideoModelV3;
+    /**
+     * Creates a model for video generation.
+     */
+    videoModel(modelId: KlingAIVideoModelId): Experimental_VideoModelV3;
+}
+/**
+ * Create a KlingAI provider instance.
+ */
+declare function createKlingAI(options?: KlingAIProviderSettings): KlingAIProvider;
+/**
+ * Default KlingAI provider instance.
+ */
+declare const klingai: KlingAIProvider;
+
+type KlingAIVideoProviderOptions = {
+    /**
+     * URL of the reference video. The character actions in the generated video
+     * are consistent with the reference video.
+     *
+     * Supports .mp4/.mov, max 100MB, side lengths 340px–3850px,
+     * duration 3–30 seconds (depends on `characterOrientation`).
+     */
+    videoUrl: string;
+    /**
+     * Orientation of the characters in the generated video.
+     *
+     * - `'image'`: Same orientation as the person in the image.
+     *   Reference video duration max 10 seconds.
+     * - `'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';
+    /**
+     * Whether to keep the original sound of the reference video.
+     * Default: `'yes'`.
+     */
+    keepOriginalSound?: 'yes' | 'no' | null;
+    /**
+     * 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 };

package/dist/index.d.ts

@@ -0,0 +1,97 @@
+import { ProviderV3, Experimental_VideoModelV3 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+
+type KlingAIVideoModelId = 'kling-v2.6-motion-control' | (string & {});
+
+interface KlingAIProviderSettings {
+    /**
+     * KlingAI Access key. Default value is taken from the `KLINGAI_ACCESS_KEY`
+     * environment variable.
+     */
+    accessKey?: string;
+    /**
+     * KlingAI Secret key. Default value is taken from the `KLINGAI_SECRET_KEY`
+     * environment variable.
+     */
+    secretKey?: string;
+    /**
+     * Base URL for the API calls.
+     */
+    baseURL?: string;
+    /**
+     * Custom headers to include in the requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom fetch implementation. You can use it as a middleware to intercept
+     * requests, or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+}
+interface KlingAIProvider extends ProviderV3 {
+    /**
+     * Creates a model for video generation.
+     */
+    video(modelId: KlingAIVideoModelId): Experimental_VideoModelV3;
+    /**
+     * Creates a model for video generation.
+     */
+    videoModel(modelId: KlingAIVideoModelId): Experimental_VideoModelV3;
+}
+/**
+ * Create a KlingAI provider instance.
+ */
+declare function createKlingAI(options?: KlingAIProviderSettings): KlingAIProvider;
+/**
+ * Default KlingAI provider instance.
+ */
+declare const klingai: KlingAIProvider;
+
+type KlingAIVideoProviderOptions = {
+    /**
+     * URL of the reference video. The character actions in the generated video
+     * are consistent with the reference video.
+     *
+     * Supports .mp4/.mov, max 100MB, side lengths 340px–3850px,
+     * duration 3–30 seconds (depends on `characterOrientation`).
+     */
+    videoUrl: string;
+    /**
+     * Orientation of the characters in the generated video.
+     *
+     * - `'image'`: Same orientation as the person in the image.
+     *   Reference video duration max 10 seconds.
+     * - `'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';
+    /**
+     * Whether to keep the original sound of the reference video.
+     * Default: `'yes'`.
+     */
+    keepOriginalSound?: 'yes' | 'no' | null;
+    /**
+     * 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 };