Passer au contenu principal
@youka/sdk est le SDK TypeScript officiel pour l’API Youka. Utilisez-le pour créer un karaoké à partir d’audio ou de vidéo, personnaliser les paroles et le style, exporter des vidéos MP4 et intégrer des workflows Youka dans des apps Node.js ou Bun.

​
Installation

npm install @youka/sdk

​
Prérequis

  • Node.js 20 ou plus récent, ou Bun 1.1+
  • Une clé API Youka dans YOUKA_API_KEY (créez-en une sur online.youka.io/account dans API keys)

​
Exemple rapide

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

​
Référence

Démarrage rapide

Exemple de bout en bout : créer, attendre, exporter, télécharger.

Authentification

Configurez YoukaClient et gérez les clés API en toute sécurité.

Compte, crédits et facturation

Identité, solde, tarifs, paiement et aides au portail de facturation.

Projets

Téléversements, création, listing et suppression.

Pistes séparées (stems)

Déclenchez des tâches de séparation des stems.

Synchronisation des paroles

Relancez la synchronisation des paroles.

Exports

Workflows d’export dans le cloud et en local.

Tâches

Inspectez les tâches et attendez leur fin.

Préréglages

Configurations de rendu réutilisables.

Médias

Téléversez des arrière-plans, des logos et des intros.

Paramètres du projet

Paramètres de rendu au niveau du projet.

Erreurs

YoukaRequestError et YoukaTaskError.

​
Et ensuite

  • Démarrage rapide — le chemin le plus court vers un karaoké terminé
  • Référence API — tous les endpoints, auto-générés depuis OpenAPI
  • Agents IA — règles de fonctionnement pour les auteurs d’agents