Skip to main content
@youka/sdk is the official TypeScript SDK for the Youka API. Use it to create karaoke from audio or video, customize lyrics and styling, export MP4 videos, and build Youka workflows into Node.js or Bun apps.

​
Install

npm install @youka/sdk

​
Requirements

  • Node.js 20 or later, or Bun 1.1+
  • A Youka API key in YOUKA_API_KEY (create one at online.youka.io/account under API keys)

​
Quick example

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

​
Reference

Quickstart

End-to-end example: create, wait, export, download.

Authentication

Configure YoukaClient and handle API keys safely.

Account, credits, and billing

Identity, balance, pricing, checkout, and billing portal helpers.

Projects

Uploads, creation, listing, and deletion.

Stems

Trigger stem separation tasks.

Lyrics sync

Re-run lyrics synchronization.

Exports

Cloud and local export workflows.

Tasks

Inspect tasks and wait for completion.

Presets

Reusable render configurations.

Media

Upload backgrounds, logos, and intros.

Project settings

Project-level render settings.

Errors

YoukaRequestError and YoukaTaskError.

​
What’s next

  • Quickstart — the shortest path to a finished karaoke
  • API reference — every endpoint, auto-generated from OpenAPI
  • AI agents — operating rules for agent authors