@apicity/kie 0.1.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +569 -0
- package/dist/src/chat.d.ts +56 -0
- package/dist/src/chat.d.ts.map +1 -0
- package/dist/src/chat.js +75 -0
- package/dist/src/chat.js.map +1 -0
- package/dist/src/claude.d.ts +76 -0
- package/dist/src/claude.d.ts.map +1 -0
- package/dist/src/claude.js +83 -0
- package/dist/src/claude.js.map +1 -0
- package/dist/src/example.d.ts +8 -0
- package/dist/src/example.d.ts.map +1 -0
- package/dist/src/example.js +186 -0
- package/dist/src/example.js.map +1 -0
- package/dist/src/index.d.ts +15 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +14 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/kie.d.ts +5 -0
- package/dist/src/kie.d.ts.map +1 -0
- package/dist/src/kie.js +388 -0
- package/dist/src/kie.js.map +1 -0
- package/dist/src/middleware.d.ts +34 -0
- package/dist/src/middleware.d.ts.map +1 -0
- package/dist/src/middleware.js +219 -0
- package/dist/src/middleware.js.map +1 -0
- package/dist/src/model-schemas.d.ts +3 -0
- package/dist/src/model-schemas.d.ts.map +1 -0
- package/dist/src/model-schemas.js +1172 -0
- package/dist/src/model-schemas.js.map +1 -0
- package/dist/src/request.d.ts +9 -0
- package/dist/src/request.d.ts.map +1 -0
- package/dist/src/request.js +46 -0
- package/dist/src/request.js.map +1 -0
- package/dist/src/sse.d.ts +2 -0
- package/dist/src/sse.d.ts.map +1 -0
- package/dist/src/sse.js +41 -0
- package/dist/src/sse.js.map +1 -0
- package/dist/src/suno.d.ts +313 -0
- package/dist/src/suno.d.ts.map +1 -0
- package/dist/src/suno.js +391 -0
- package/dist/src/suno.js.map +1 -0
- package/dist/src/types.d.ts +119 -0
- package/dist/src/types.d.ts.map +1 -0
- package/dist/src/types.js +14 -0
- package/dist/src/types.js.map +1 -0
- package/dist/src/veo.d.ts +52 -0
- package/dist/src/veo.d.ts.map +1 -0
- package/dist/src/veo.js +40 -0
- package/dist/src/veo.js.map +1 -0
- package/dist/src/zod.d.ts +1982 -0
- package/dist/src/zod.d.ts.map +1 -0
- package/dist/src/zod.js +866 -0
- package/dist/src/zod.js.map +1 -0
- package/package.json +61 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Justin Tanner
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,569 @@
|
|
|
1
|
+
# @apicity/kie
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@apicity/kie)
|
|
4
|
+
[](package.json)
|
|
5
|
+
[](tsconfig.json)
|
|
6
|
+
|
|
7
|
+
Kie provider for video and image generation (Kling 3.0, Grok Imagine, Nano Banana Pro).
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @apicity/kie
|
|
13
|
+
# or
|
|
14
|
+
pnpm add @apicity/kie
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { kie as createKie } from "@apicity/kie";
|
|
21
|
+
|
|
22
|
+
const kie = createKie({ apiKey: process.env.KIE_API_KEY! });
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Real-world example: Kling 3.0 video with named element references
|
|
26
|
+
|
|
27
|
+
Kling 3.0/video has a feature most upstream video models lack — **named
|
|
28
|
+
element references**. You upload reference images for each subject, give
|
|
29
|
+
the subject a `name` and `description`, and refer back to it from the
|
|
30
|
+
prompt with `[name]` placeholders. The result preserves identity across
|
|
31
|
+
frames without prompt-engineering gymnastics.
|
|
32
|
+
|
|
33
|
+
The flow below is taken verbatim from
|
|
34
|
+
[`tests/integration/kie-kling-30-reference-bakeoff.test.ts`](../../../tests/integration/kie-kling-30-reference-bakeoff.test.ts)
|
|
35
|
+
and replays against
|
|
36
|
+
[`tests/recordings/kie_2079838932/kling-30-reference-bakeoff_875607413/recording.har`](../../../tests/recordings/kie_2079838932/kling-30-reference-bakeoff_875607413/recording.har),
|
|
37
|
+
so the response shapes match what Kie actually returns.
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { readFileSync } from "node:fs";
|
|
41
|
+
import { kie as createKie } from "@apicity/kie";
|
|
42
|
+
|
|
43
|
+
const kie = createKie({ apiKey: process.env.KIE_API_KEY! });
|
|
44
|
+
|
|
45
|
+
// 1. Upload each reference image. Kie returns a CDN-hosted
|
|
46
|
+
// `downloadUrl` you'll thread through the job request — the bytes
|
|
47
|
+
// themselves never live in the createTask payload.
|
|
48
|
+
async function upload(filename: string, mimeType: string): Promise<string> {
|
|
49
|
+
const blob = new Blob([readFileSync(filename)], { type: mimeType });
|
|
50
|
+
const res = await kie.post.api.fileStreamUpload({
|
|
51
|
+
file: blob,
|
|
52
|
+
filename,
|
|
53
|
+
uploadPath: "images/test-uploads",
|
|
54
|
+
});
|
|
55
|
+
if (!res.data?.downloadUrl) throw new Error("upload failed");
|
|
56
|
+
return res.data.downloadUrl;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// Two angles of the cat satisfy Kling's "2-4 images per element"
|
|
60
|
+
// minimum. The man only has one fixture, so we pass it twice.
|
|
61
|
+
const cat1 = await upload("cat1.jpg", "image/jpeg");
|
|
62
|
+
const cat2 = await upload("cat2.jpg", "image/jpeg");
|
|
63
|
+
const man = await upload("man.jpg", "image/jpeg");
|
|
64
|
+
const beach = await upload("beach.png", "image/png");
|
|
65
|
+
|
|
66
|
+
// 2. Submit the job. Each `kling_elements` entry binds a `name` to a
|
|
67
|
+
// set of reference images; the prompt then refers to that subject
|
|
68
|
+
// via `[name]`. `image_urls` carries general/setting references —
|
|
69
|
+
// the beach plate here — that aren't tied to a named subject.
|
|
70
|
+
const task = await kie.post.api.v1.jobs.createTask({
|
|
71
|
+
model: "kling-3.0/video",
|
|
72
|
+
input: {
|
|
73
|
+
prompt:
|
|
74
|
+
"On a sandy beach with the ocean behind, [blue_suit_man] sits " +
|
|
75
|
+
"cross-legged on the sand. [white_cat] climbs onto his lap, " +
|
|
76
|
+
"purrs, and lifts a paw to bat playfully at his blue tie. " +
|
|
77
|
+
"[blue_suit_man] smiles and waves at the camera with his free hand.",
|
|
78
|
+
image_urls: [beach],
|
|
79
|
+
kling_elements: [
|
|
80
|
+
{
|
|
81
|
+
name: "white_cat",
|
|
82
|
+
description: "A white cat with mismatched yellow and blue eyes",
|
|
83
|
+
element_input_urls: [cat1, cat2],
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
name: "blue_suit_man",
|
|
87
|
+
description: "A man wearing a blue suit and a blue tie",
|
|
88
|
+
element_input_urls: [man, man],
|
|
89
|
+
},
|
|
90
|
+
],
|
|
91
|
+
sound: false,
|
|
92
|
+
duration: "5",
|
|
93
|
+
aspect_ratio: "16:9",
|
|
94
|
+
mode: "std",
|
|
95
|
+
multi_shots: false,
|
|
96
|
+
},
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
if (!task.data?.taskId) throw new Error("createTask returned no taskId");
|
|
100
|
+
const taskId = task.data.taskId;
|
|
101
|
+
// → "56074f12319c68b246e5a03e05608f31"
|
|
102
|
+
|
|
103
|
+
// 3. Poll recordInfo until the job leaves the `generating` state.
|
|
104
|
+
// Kie's terminal states are `success` and `fail` — anything else
|
|
105
|
+
// (`waiting`, `queuing`, `generating`) means keep waiting.
|
|
106
|
+
let state: string = "waiting";
|
|
107
|
+
let resultJson: string | undefined;
|
|
108
|
+
for (let i = 0; i < 200; i++) {
|
|
109
|
+
const info = await kie.get.api.v1.jobs.recordInfo(taskId);
|
|
110
|
+
state = info.data?.state ?? "waiting";
|
|
111
|
+
if (state === "success" || state === "fail") {
|
|
112
|
+
resultJson = info.data?.resultJson;
|
|
113
|
+
break;
|
|
114
|
+
}
|
|
115
|
+
await new Promise((r) => setTimeout(r, 10_000));
|
|
116
|
+
}
|
|
117
|
+
if (state !== "success" || !resultJson) throw new Error(`job ${state}`);
|
|
118
|
+
|
|
119
|
+
// 4. `resultJson` is a JSON-encoded string — parse it to get the
|
|
120
|
+
// delivered media URLs. The shape is consistent across every kie
|
|
121
|
+
// media model (single `resultUrls: string[]`).
|
|
122
|
+
const result = JSON.parse(resultJson) as { resultUrls: string[] };
|
|
123
|
+
console.log(result.resultUrls[0]);
|
|
124
|
+
// → "https://tempfile.aiquickdraw.com/k/56074f12319c68b246e5a03e05608f31_1_1777540551_7969.mp4"
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
**Notes**
|
|
128
|
+
|
|
129
|
+
- `kling_elements` accepts at most 3 named subjects, and each
|
|
130
|
+
`element_input_urls` array must hold **2–4 images**. If you only have
|
|
131
|
+
one reference per subject, repeat it (as the example does for `man`)
|
|
132
|
+
to satisfy the minimum.
|
|
133
|
+
- The poll loop watches for the terminal states `success` and `fail` —
|
|
134
|
+
anything else (`waiting`, `queuing`, `generating`) means keep going.
|
|
135
|
+
There's no `check_after_secs` hint as on some other providers, so a
|
|
136
|
+
10s cadence is conservative; in the recorded fixture the job
|
|
137
|
+
completed after ~127s of generating (14 polls).
|
|
138
|
+
- `kie.post.api.v1.jobs.createTask` is the unified entry point for every
|
|
139
|
+
media model in this provider — Kling, Wan, Seedance, Grok Imagine,
|
|
140
|
+
GPT-Image-2, Qwen2, and others. Swap the `model` and `input` block;
|
|
141
|
+
the rest of the flow (upload → createTask → poll → parse `resultJson`)
|
|
142
|
+
is identical.
|
|
143
|
+
- For convenience, `submitMediaJob(provider, request)` and
|
|
144
|
+
`uploadFile(provider, blob, filename, uploadPath)` re-export the same
|
|
145
|
+
calls but throw `KieError` directly when the upstream envelope is
|
|
146
|
+
missing the expected fields.
|
|
147
|
+
- Errors surface as `KieError` with `status`, `body`, and an upstream
|
|
148
|
+
`code` attached, so
|
|
149
|
+
`try { ... } catch (e) { if (e instanceof KieError) ... }` gives you
|
|
150
|
+
the upstream error directly.
|
|
151
|
+
|
|
152
|
+
## API Reference
|
|
153
|
+
|
|
154
|
+
26 endpoints across 15 groups. Each method mirrors an upstream URL path.
|
|
155
|
+
|
|
156
|
+
### chat
|
|
157
|
+
|
|
158
|
+
<details>
|
|
159
|
+
<summary><code>GET</code> <b><code>kie.get.api.v1.chat.credit</code></b></summary>
|
|
160
|
+
|
|
161
|
+
<code>GET https://api.kie.ai/api/v1/chat/credit</code>
|
|
162
|
+
|
|
163
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
164
|
+
|
|
165
|
+
```typescript
|
|
166
|
+
const res = await kie.get.api.v1.chat.credit({ /* ... */ });
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
Source: [`packages/provider/kie/src/kie.ts`](src/kie.ts)
|
|
170
|
+
|
|
171
|
+
</details>
|
|
172
|
+
|
|
173
|
+
### claude
|
|
174
|
+
|
|
175
|
+
<details>
|
|
176
|
+
<summary><code>POST</code> <b><code>kie.claude.post.v1.messages</code></b></summary>
|
|
177
|
+
|
|
178
|
+
<code>POST https://api.kie.ai/claude/v1/messages</code>
|
|
179
|
+
|
|
180
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
181
|
+
|
|
182
|
+
```typescript
|
|
183
|
+
const res = await kie.claude.post.v1.messages({ /* ... */ });
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
Source: [`packages/provider/kie/src/claude.ts`](src/claude.ts)
|
|
187
|
+
|
|
188
|
+
</details>
|
|
189
|
+
|
|
190
|
+
### common
|
|
191
|
+
|
|
192
|
+
<details>
|
|
193
|
+
<summary><code>POST</code> <b><code>kie.post.api.v1.common.downloadUrl</code></b></summary>
|
|
194
|
+
|
|
195
|
+
<code>POST https://api.kie.ai/api/v1/common/download-url</code>
|
|
196
|
+
|
|
197
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
const res = await kie.post.api.v1.common.downloadUrl({ /* ... */ });
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
Source: [`packages/provider/kie/src/kie.ts`](src/kie.ts)
|
|
204
|
+
|
|
205
|
+
</details>
|
|
206
|
+
|
|
207
|
+
### fileBase64Upload
|
|
208
|
+
|
|
209
|
+
<details>
|
|
210
|
+
<summary><code>POST</code> <b><code>kie.post.api.fileBase64Upload</code></b></summary>
|
|
211
|
+
|
|
212
|
+
<code>POST https://api.kie.ai/api/file-base64-upload</code>
|
|
213
|
+
|
|
214
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
215
|
+
|
|
216
|
+
```typescript
|
|
217
|
+
const res = await kie.post.api.fileBase64Upload({ /* ... */ });
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
Source: [`packages/provider/kie/src/kie.ts`](src/kie.ts)
|
|
221
|
+
|
|
222
|
+
</details>
|
|
223
|
+
|
|
224
|
+
### fileStreamUpload
|
|
225
|
+
|
|
226
|
+
<details>
|
|
227
|
+
<summary><code>POST</code> <b><code>kie.post.api.fileStreamUpload</code></b></summary>
|
|
228
|
+
|
|
229
|
+
<code>POST https://api.kie.ai/api/file-stream-upload</code>
|
|
230
|
+
|
|
231
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
const res = await kie.post.api.fileStreamUpload({ /* ... */ });
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
Source: [`packages/provider/kie/src/kie.ts`](src/kie.ts)
|
|
238
|
+
|
|
239
|
+
</details>
|
|
240
|
+
|
|
241
|
+
### fileUrlUpload
|
|
242
|
+
|
|
243
|
+
<details>
|
|
244
|
+
<summary><code>POST</code> <b><code>kie.post.api.fileUrlUpload</code></b></summary>
|
|
245
|
+
|
|
246
|
+
<code>POST https://api.kie.ai/api/file-url-upload</code>
|
|
247
|
+
|
|
248
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
249
|
+
|
|
250
|
+
```typescript
|
|
251
|
+
const res = await kie.post.api.fileUrlUpload({ /* ... */ });
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
Source: [`packages/provider/kie/src/kie.ts`](src/kie.ts)
|
|
255
|
+
|
|
256
|
+
</details>
|
|
257
|
+
|
|
258
|
+
### generate
|
|
259
|
+
|
|
260
|
+
<details>
|
|
261
|
+
<summary><code>GET</code> <b><code>kie.suno.get.api.v1.generate.recordInfo</code></b></summary>
|
|
262
|
+
|
|
263
|
+
<code>GET https://api.kie.ai/api/v1/generate/record-info?taskId={taskId}</code>
|
|
264
|
+
|
|
265
|
+
```typescript
|
|
266
|
+
const res = await kie.suno.get.api.v1.generate.recordInfo({ /* ... */ });
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
270
|
+
|
|
271
|
+
</details>
|
|
272
|
+
|
|
273
|
+
<details>
|
|
274
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate</code></b></summary>
|
|
275
|
+
|
|
276
|
+
<code>POST https://api.kie.ai/api/v1/generate</code>
|
|
277
|
+
|
|
278
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
279
|
+
|
|
280
|
+
```typescript
|
|
281
|
+
const res = await kie.suno.post.api.v1.generate({ /* ... */ });
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
285
|
+
|
|
286
|
+
</details>
|
|
287
|
+
|
|
288
|
+
<details>
|
|
289
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.addInstrumental</code></b></summary>
|
|
290
|
+
|
|
291
|
+
<code>POST https://api.kie.ai/api/v1/generate/add-instrumental</code>
|
|
292
|
+
|
|
293
|
+
[Upstream docs ↗](https://docs.kie.ai/suno-api/add-instrumental)
|
|
294
|
+
|
|
295
|
+
```typescript
|
|
296
|
+
const res = await kie.suno.post.api.v1.generate.addInstrumental({ /* ... */ });
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
300
|
+
|
|
301
|
+
</details>
|
|
302
|
+
|
|
303
|
+
<details>
|
|
304
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.addVocals</code></b></summary>
|
|
305
|
+
|
|
306
|
+
<code>POST https://api.kie.ai/api/v1/generate/add-vocals</code>
|
|
307
|
+
|
|
308
|
+
[Upstream docs ↗](https://docs.kie.ai/suno-api/add-vocals)
|
|
309
|
+
|
|
310
|
+
```typescript
|
|
311
|
+
const res = await kie.suno.post.api.v1.generate.addVocals({ /* ... */ });
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
315
|
+
|
|
316
|
+
</details>
|
|
317
|
+
|
|
318
|
+
<details>
|
|
319
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.extend</code></b></summary>
|
|
320
|
+
|
|
321
|
+
<code>POST https://api.kie.ai/api/v1/generate/extend</code>
|
|
322
|
+
|
|
323
|
+
```typescript
|
|
324
|
+
const res = await kie.suno.post.api.v1.generate.extend({ /* ... */ });
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
328
|
+
|
|
329
|
+
</details>
|
|
330
|
+
|
|
331
|
+
<details>
|
|
332
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.mashup</code></b></summary>
|
|
333
|
+
|
|
334
|
+
<code>POST https://api.kie.ai/api/v1/generate/mashup</code>
|
|
335
|
+
|
|
336
|
+
[Upstream docs ↗](https://docs.kie.ai/suno-api/generate-mashup)
|
|
337
|
+
|
|
338
|
+
```typescript
|
|
339
|
+
const res = await kie.suno.post.api.v1.generate.mashup({ /* ... */ });
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
343
|
+
|
|
344
|
+
</details>
|
|
345
|
+
|
|
346
|
+
<details>
|
|
347
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.replaceSection</code></b></summary>
|
|
348
|
+
|
|
349
|
+
<code>POST https://api.kie.ai/api/v1/generate/replace-section</code>
|
|
350
|
+
|
|
351
|
+
[Upstream docs ↗](https://docs.kie.ai/suno-api/replace-section)
|
|
352
|
+
|
|
353
|
+
```typescript
|
|
354
|
+
const res = await kie.suno.post.api.v1.generate.replaceSection({ /* ... */ });
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
358
|
+
|
|
359
|
+
</details>
|
|
360
|
+
|
|
361
|
+
<details>
|
|
362
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.sounds</code></b></summary>
|
|
363
|
+
|
|
364
|
+
<code>POST https://api.kie.ai/api/v1/generate/sounds</code>
|
|
365
|
+
|
|
366
|
+
[Upstream docs ↗](https://docs.kie.ai/suno-api/generate-sounds)
|
|
367
|
+
|
|
368
|
+
```typescript
|
|
369
|
+
const res = await kie.suno.post.api.v1.generate.sounds({ /* ... */ });
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
373
|
+
|
|
374
|
+
</details>
|
|
375
|
+
|
|
376
|
+
<details>
|
|
377
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.uploadCover</code></b></summary>
|
|
378
|
+
|
|
379
|
+
<code>POST https://api.kie.ai/api/v1/generate/upload-cover</code>
|
|
380
|
+
|
|
381
|
+
```typescript
|
|
382
|
+
const res = await kie.suno.post.api.v1.generate.uploadCover({ /* ... */ });
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
386
|
+
|
|
387
|
+
</details>
|
|
388
|
+
|
|
389
|
+
<details>
|
|
390
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.generate.uploadExtend</code></b></summary>
|
|
391
|
+
|
|
392
|
+
<code>POST https://api.kie.ai/api/v1/generate/upload-extend</code>
|
|
393
|
+
|
|
394
|
+
```typescript
|
|
395
|
+
const res = await kie.suno.post.api.v1.generate.uploadExtend({ /* ... */ });
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
399
|
+
|
|
400
|
+
</details>
|
|
401
|
+
|
|
402
|
+
### jobs
|
|
403
|
+
|
|
404
|
+
<details>
|
|
405
|
+
<summary><code>GET</code> <b><code>kie.get.api.v1.jobs.recordInfo</code></b></summary>
|
|
406
|
+
|
|
407
|
+
<code>GET https://api.kie.ai/api/v1/jobs/recordInfo?taskId={taskId}</code>
|
|
408
|
+
|
|
409
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
410
|
+
|
|
411
|
+
```typescript
|
|
412
|
+
const res = await kie.get.api.v1.jobs.recordInfo({ /* ... */ });
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
Source: [`packages/provider/kie/src/kie.ts`](src/kie.ts)
|
|
416
|
+
|
|
417
|
+
</details>
|
|
418
|
+
|
|
419
|
+
<details>
|
|
420
|
+
<summary><code>POST</code> <b><code>kie.post.api.v1.jobs.createTask</code></b></summary>
|
|
421
|
+
|
|
422
|
+
<code>POST https://api.kie.ai/api/v1/jobs/createTask</code>
|
|
423
|
+
|
|
424
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
425
|
+
|
|
426
|
+
```typescript
|
|
427
|
+
const res = await kie.post.api.v1.jobs.createTask({ /* ... */ });
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
Source: [`packages/provider/kie/src/kie.ts`](src/kie.ts)
|
|
431
|
+
|
|
432
|
+
</details>
|
|
433
|
+
|
|
434
|
+
### lyrics
|
|
435
|
+
|
|
436
|
+
<details>
|
|
437
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.lyrics</code></b></summary>
|
|
438
|
+
|
|
439
|
+
<code>POST https://api.kie.ai/api/v1/lyrics</code>
|
|
440
|
+
|
|
441
|
+
```typescript
|
|
442
|
+
const res = await kie.suno.post.api.v1.lyrics({ /* ... */ });
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
446
|
+
|
|
447
|
+
</details>
|
|
448
|
+
|
|
449
|
+
### midi
|
|
450
|
+
|
|
451
|
+
<details>
|
|
452
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.midi.generate</code></b></summary>
|
|
453
|
+
|
|
454
|
+
<code>POST https://api.kie.ai/api/v1/midi/generate</code>
|
|
455
|
+
|
|
456
|
+
```typescript
|
|
457
|
+
const res = await kie.suno.post.api.v1.midi.generate({ /* ... */ });
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
461
|
+
|
|
462
|
+
</details>
|
|
463
|
+
|
|
464
|
+
### mp4
|
|
465
|
+
|
|
466
|
+
<details>
|
|
467
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.mp4.generate</code></b></summary>
|
|
468
|
+
|
|
469
|
+
<code>POST https://api.kie.ai/api/v1/mp4/generate</code>
|
|
470
|
+
|
|
471
|
+
```typescript
|
|
472
|
+
const res = await kie.suno.post.api.v1.mp4.generate({ /* ... */ });
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
476
|
+
|
|
477
|
+
</details>
|
|
478
|
+
|
|
479
|
+
### style
|
|
480
|
+
|
|
481
|
+
<details>
|
|
482
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.style.generate</code></b></summary>
|
|
483
|
+
|
|
484
|
+
<code>POST https://api.kie.ai/api/v1/style/generate</code>
|
|
485
|
+
|
|
486
|
+
```typescript
|
|
487
|
+
const res = await kie.suno.post.api.v1.style.generate({ /* ... */ });
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
491
|
+
|
|
492
|
+
</details>
|
|
493
|
+
|
|
494
|
+
### veo
|
|
495
|
+
|
|
496
|
+
<details>
|
|
497
|
+
<summary><code>POST</code> <b><code>kie.veo.post.api.v1.veo.extend</code></b></summary>
|
|
498
|
+
|
|
499
|
+
<code>POST https://api.kie.ai/api/v1/veo/extend</code>
|
|
500
|
+
|
|
501
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
502
|
+
|
|
503
|
+
```typescript
|
|
504
|
+
const res = await kie.veo.post.api.v1.veo.extend({ /* ... */ });
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
Source: [`packages/provider/kie/src/veo.ts`](src/veo.ts)
|
|
508
|
+
|
|
509
|
+
</details>
|
|
510
|
+
|
|
511
|
+
<details>
|
|
512
|
+
<summary><code>POST</code> <b><code>kie.veo.post.api.v1.veo.generate</code></b></summary>
|
|
513
|
+
|
|
514
|
+
<code>POST https://api.kie.ai/api/v1/veo/generate</code>
|
|
515
|
+
|
|
516
|
+
[Upstream docs ↗](https://docs.kie.ai)
|
|
517
|
+
|
|
518
|
+
```typescript
|
|
519
|
+
const res = await kie.veo.post.api.v1.veo.generate({ /* ... */ });
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
Source: [`packages/provider/kie/src/veo.ts`](src/veo.ts)
|
|
523
|
+
|
|
524
|
+
</details>
|
|
525
|
+
|
|
526
|
+
### vocalRemoval
|
|
527
|
+
|
|
528
|
+
<details>
|
|
529
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.vocalRemoval.generate</code></b></summary>
|
|
530
|
+
|
|
531
|
+
<code>POST https://api.kie.ai/api/v1/vocal-removal/generate</code>
|
|
532
|
+
|
|
533
|
+
```typescript
|
|
534
|
+
const res = await kie.suno.post.api.v1.vocalRemoval.generate({ /* ... */ });
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
538
|
+
|
|
539
|
+
</details>
|
|
540
|
+
|
|
541
|
+
### wav
|
|
542
|
+
|
|
543
|
+
<details>
|
|
544
|
+
<summary><code>POST</code> <b><code>kie.suno.post.api.v1.wav.generate</code></b></summary>
|
|
545
|
+
|
|
546
|
+
<code>POST https://api.kie.ai/api/v1/wav/generate</code>
|
|
547
|
+
|
|
548
|
+
```typescript
|
|
549
|
+
const res = await kie.suno.post.api.v1.wav.generate({ /* ... */ });
|
|
550
|
+
```
|
|
551
|
+
|
|
552
|
+
Source: [`packages/provider/kie/src/suno.ts`](src/suno.ts)
|
|
553
|
+
|
|
554
|
+
</details>
|
|
555
|
+
|
|
556
|
+
## Middleware
|
|
557
|
+
|
|
558
|
+
```typescript
|
|
559
|
+
import { kie as createKie, withRetry } from "@apicity/kie";
|
|
560
|
+
|
|
561
|
+
const kie = createKie({ apiKey: process.env.KIE_API_KEY! });
|
|
562
|
+
const models = withRetry(kie.get.v1.models, { retries: 3 });
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
Part of the [apicity](https://github.com/justintanner/apicity) monorepo.
|
|
566
|
+
|
|
567
|
+
## License
|
|
568
|
+
|
|
569
|
+
MIT — see [LICENSE](LICENSE).
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { z } from "zod";
|
|
2
|
+
export interface KieChatContentPart {
|
|
3
|
+
type: "text" | "image_url";
|
|
4
|
+
text?: string;
|
|
5
|
+
image_url?: {
|
|
6
|
+
url: string;
|
|
7
|
+
};
|
|
8
|
+
}
|
|
9
|
+
export interface KieChatMessage {
|
|
10
|
+
role: "user" | "assistant" | "system";
|
|
11
|
+
content: string | KieChatContentPart[];
|
|
12
|
+
}
|
|
13
|
+
export interface KieChatRequest {
|
|
14
|
+
model: string;
|
|
15
|
+
messages: KieChatMessage[];
|
|
16
|
+
temperature?: number;
|
|
17
|
+
max_tokens?: number;
|
|
18
|
+
stream?: boolean;
|
|
19
|
+
response_format?: {
|
|
20
|
+
type: "text" | "json_object" | "json_schema";
|
|
21
|
+
json_schema?: Record<string, unknown>;
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
export interface KieChatChoice {
|
|
25
|
+
index?: number;
|
|
26
|
+
message?: {
|
|
27
|
+
role?: string;
|
|
28
|
+
content?: string;
|
|
29
|
+
};
|
|
30
|
+
finish_reason?: string;
|
|
31
|
+
}
|
|
32
|
+
export interface KieChatUsage {
|
|
33
|
+
prompt_tokens?: number;
|
|
34
|
+
completion_tokens?: number;
|
|
35
|
+
total_tokens?: number;
|
|
36
|
+
}
|
|
37
|
+
export interface KieChatResponse {
|
|
38
|
+
id?: string;
|
|
39
|
+
object?: string;
|
|
40
|
+
created?: number;
|
|
41
|
+
model?: string;
|
|
42
|
+
choices?: KieChatChoice[];
|
|
43
|
+
usage?: KieChatUsage;
|
|
44
|
+
error?: string;
|
|
45
|
+
code?: number;
|
|
46
|
+
}
|
|
47
|
+
interface KieChatCompletionsMethod {
|
|
48
|
+
(req: KieChatRequest, signal?: AbortSignal): Promise<KieChatResponse>;
|
|
49
|
+
schema: z.ZodType<KieChatRequest>;
|
|
50
|
+
}
|
|
51
|
+
export interface KieChatProvider {
|
|
52
|
+
completions: KieChatCompletionsMethod;
|
|
53
|
+
}
|
|
54
|
+
export declare function createChatProvider(baseURL: string, apiKey: string, doFetch: typeof fetch, timeout: number): KieChatProvider;
|
|
55
|
+
export {};
|
|
56
|
+
//# sourceMappingURL=chat.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/chat.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAmB7B,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;IACtC,OAAO,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,aAAa,CAAC;QAC7C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACvC,CAAC;CACH;AAGD,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,UAAU,wBAAwB;IAChC,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACtE,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,wBAAwB,CAAC;CACvC;AAqED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,KAAK,EACrB,OAAO,EAAE,MAAM,GACd,eAAe,CAYjB"}
|