Chuyển đến nội dung chính
@youka/sdk là TypeScript SDK chính thức cho Youka API. Dùng nó để tạo karaoke từ audio hoặc video, tùy chỉnh lời bài hát và styling, xuất video MP4, và tích hợp các workflow Youka vào ứng dụng Node.js hoặc Bun.

​
Cài đặt

npm install @youka/sdk

​
Yêu cầu

  • Node.js 20 trở lên, hoặc Bun 1.1+
  • Một Youka API key trong YOUKA_API_KEY (tạo tại online.youka.io/account dưới mục API keys)

​
Ví dụ nhanh

import { YoukaClient } from "@youka/vi/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);

​
Tham khảo

Quickstart

Ví dụ end-to-end: tạo, chờ, xuất, tải xuống.

Authentication

Cấu hình YoukaClient và xử lý API key an toàn.

Account, credits, and billing

Trợ giúp về định danh, số dư, giá, thanh toán, và cổng quản lý hóa đơn.

Projects

Upload, tạo, liệt kê, và xóa.

Stems

Kích hoạt các tác vụ tách stem.

Lyrics sync

Chạy lại đồng bộ lời bài hát.

Exports

Workflow xuất trên cloud và local.

Tasks

Kiểm tra tác vụ và chờ hoàn tất.

Presets

Cấu hình render có thể tái sử dụng.

Media

Upload nền, logo, và intro.

Project settings

Cài đặt render ở cấp dự án.

Errors

YoukaRequestError và YoukaTaskError.

​
Tiếp theo

  • Quickstart — con đường ngắn nhất để có một karaoke hoàn chỉnh
  • API reference — mọi endpoint, được tự động tạo từ OpenAPI
  • AI agents — quy tắc vận hành dành cho tác giả agent