> ## Documentation Index
> Fetch the complete documentation index at: https://docs.youka.io/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK Node.js

> Automatisez Youka depuis Node.js et Bun avec le SDK TypeScript officiel

`@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

<CodeGroup>
  ```bash npm theme={null}
  npm install @youka/sdk
  ```

  ```bash pnpm theme={null}
  pnpm add @youka/sdk
  ```

  ```bash yarn theme={null}
  yarn add @youka/sdk
  ```

  ```bash bun theme={null}
  bun add @youka/sdk
  ```
</CodeGroup>

## 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](https://online.youka.io/account) dans **API keys**)

## Exemple rapide

```ts theme={null}
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

<Columns cols={2}>
  <Card title="Démarrage rapide" icon="rocket" href="/fr/sdk/quickstart">
    Exemple de bout en bout : créer, attendre, exporter, télécharger.
  </Card>

  <Card title="Authentification" icon="key" href="/fr/sdk/authentication">
    Configurez `YoukaClient` et gérez les clés API en toute sécurité.
  </Card>

  <Card title="Compte, crédits et facturation" icon="credit-card" href="/fr/sdk/account-billing">
    Identité, solde, tarifs, paiement et aides au portail de facturation.
  </Card>

  <Card title="Projets" icon="folder" href="/fr/sdk/projects">
    Téléversements, création, listing et suppression.
  </Card>

  <Card title="Pistes séparées (stems)" icon="waveform-lines" href="/fr/sdk/stems">
    Déclenchez des tâches de séparation des stems.
  </Card>

  <Card title="Synchronisation des paroles" icon="closed-captioning" href="/fr/sdk/lyrics-sync">
    Relancez la synchronisation des paroles.
  </Card>

  <Card title="Exports" icon="file-video" href="/fr/sdk/exports">
    Workflows d’export dans le cloud et en local.
  </Card>

  <Card title="Tâches" icon="list-check" href="/fr/sdk/tasks">
    Inspectez les tâches et attendez leur fin.
  </Card>

  <Card title="Préréglages" icon="palette" href="/fr/sdk/presets">
    Configurations de rendu réutilisables.
  </Card>

  <Card title="Médias" icon="image" href="/fr/sdk/media">
    Téléversez des arrière-plans, des logos et des intros.
  </Card>

  <Card title="Paramètres du projet" icon="sliders" href="/fr/sdk/project-settings">
    Paramètres de rendu au niveau du projet.
  </Card>

  <Card title="Erreurs" icon="triangle-exclamation" href="/fr/sdk/errors">
    `YoukaRequestError` et `YoukaTaskError`.
  </Card>
</Columns>

## Et ensuite

* [Démarrage rapide](/fr/sdk/quickstart) — le chemin le plus court vers un karaoké terminé
* [Référence API](/fr/api) — tous les endpoints, auto-générés depuis OpenAPI
* [Agents IA](/fr/agents) — règles de fonctionnement pour les auteurs d’agents