跳转到主要内容
@youka/sdk 是 Youka API 的官方 TypeScript SDK。使用它可以从音频或视频创建卡拉 OK，自定义歌词与样式，导出 MP4 视频，并将 Youka 工作流构建到 Node.js 或 Bun 应用中。

​
安装

npm install @youka/sdk

​
要求

  • Node.js 20 或更高版本，或 Bun 1.1+
  • 在 YOUKA_API_KEY 中配置 Youka API key（在 online.youka.io/account 的 API keys 下创建）

​
快速示例

import { YoukaClient } from "@youka/zh/sdk";

const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
});

const operation = await client.projects.create({
  source: { type: "path", path: "./song.mp3" },
  lyricsSource: { type: "transcribe" },
});

const { project } = await client.projects.wait(operation);
console.log(project.id, project.title);

​
参考

Quickstart

端到端示例：创建、等待、导出、下载。

Authentication

配置 YoukaClient 并安全地处理 API keys。

Account, credits, and billing

身份、余额、定价、结账与账单门户辅助工具。

Projects

上传、创建、列表与删除。

Stems

触发声部分离任务。

Lyrics sync

重新运行歌词同步。

Exports

云端与本地导出工作流。

Tasks

查看任务并等待完成。

Presets

可复用的渲染配置。

Media

上传背景、Logo 和片头。

Project settings

项目级渲染设置。

Errors

YoukaRequestError 和 YoukaTaskError。

​
下一步

  • Quickstart — 通往成品卡拉 OK 的最短路径
  • API reference — 所有端点，由 OpenAPI 自动生成
  • AI agents — 面向代理作者的操作规则