Node.js SDK - Youka Docs

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

Installation

npm install @youka/sdk

pnpm add @youka/sdk

yarn add @youka/sdk

bun add @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)

Kurzes 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

Identität, Guthaben, Preise, Checkout- und Billing-Portal-Helpers.

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 Abschluss warten.

Presets

Wiederverwendbare Render-Konfigurationen.

Media

Hintergründe, Logos und Intros hochladen.

Project settings

Render-Einstellungen auf Projektebene.

Errors

YoukaRequestError und YoukaTaskError.

Wie geht’s weiter

Quickstart — der kürzeste Weg zu einem fertigen Karaoke
API reference — jeder Endpoint, automatisch aus OpenAPI generiert
AI agents — Betriebsregeln für Agent-Autor:innen

​Installation

​Anforderungen

​Kurzes Beispiel

​Referenz