Zum Hauptinhalt springen
@youka/sdk ist das offizielle TypeScript SDK für die Youka API. Verwende es, um aus Audio oder Video Karaoke zu erstellen, Lyrics und Styling anzupassen, MP4-Videos zu exportieren und Youka-Workflows in Node.js- oder Bun-Apps zu integrieren.

​
Installieren

npm install @youka/sdk

​
Anforderungen

  • Node.js 20 oder neuer, oder Bun 1.1+
  • Ein Youka API key in YOUKA_API_KEY (erstelle einen unter online.youka.io/account unter API keys)

​
Schnelles Beispiel

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

​
Referenz

Quickstart

End-to-end-Beispiel: erstellen, warten, exportieren, herunterladen.

Authentication

YoukaClient konfigurieren und API keys sicher handhaben.

Account, credits, and billing

Identity-, Balance-, Pricing-, Checkout- und Billing-Portal-Helper.

Projects

Uploads, Erstellung, Auflisten und Löschen.

Stems

Stem-Separation-Tasks auslösen.

Lyrics sync

Lyrics-Synchronisierung erneut ausführen.

Exports

Cloud- und lokale Export-Workflows.

Tasks

Tasks prüfen und auf den Abschluss warten.

Presets

Wiederverwendbare Render-Konfigurationen.

Media

Hintergründe, Logos und Intros hochladen.

Project settings

Render-Einstellungen auf Projektebene.

Errors

YoukaRequestError und YoukaTaskError.

​
Was als Nächstes

  • Quickstart — der schnellste Weg zu einem fertigen Karaoke
  • API reference — jeder Endpoint, automatisch aus OpenAPI generiert
  • AI agents — Betriebsregeln für Agent-Autoren