> ## 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.

# Quickstart

> Créez un projet de karaoké, attendez qu’il se termine, exportez-le et téléchargez le résultat

Ce guide présente le chemin le plus rapide, à partir d’un fichier audio brut jusqu’à une vidéo de karaoké rendue, en utilisant `@youka/sdk`.

## Avant de commencer

* Node.js 20 ou version ultérieure
* 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**)
* Un fichier audio local (`./song.mp3`) ou une URL distante

## Installation

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

## Créer, attendre, exporter

```ts theme={null}
import { YoukaClient, YoukaRequestError, YoukaTaskError } from "@youka/sdk";

const client = new YoukaClient({
  apiKey: process.env.YOUKA_API_KEY!,
});

async function main() {
  // 1. Créer un projet à partir d’un fichier local
  const projectOperation = await client.projects.create({
    source: { type: "path", path: "./song.mp3" },
    lyricsSource: { type: "transcribe" },
  });

  // 2. Attendre la fin de la séparation des stems et de la synchro des paroles
  const { project } = await client.projects.wait(projectOperation);
  console.log("Project ready:", project.id, project.title);

  // 3. Démarrer un export
  const exportOperation = await client.exports.create(project.id, {
    resolution: "1080p",
    quality: "high",
  });

  // 4. Attendre la fin de l’export
  const finishedExport = await client.exports.wait(exportOperation);
  await client.exports.download(finishedExport, {
    output: "./exports",
  });
  console.log("Export ready:", finishedExport.url);
}

main().catch((error) => {
  if (error instanceof YoukaRequestError) {
    console.error("Request failed:", error.code, error.status, error.message);
    process.exit(1);
  }
  if (error instanceof YoukaTaskError) {
    console.error("Task failed:", error.code, error.status, error.message);
    process.exit(1);
  }
  throw error;
});
```

<Note>
  `client.projects.create()` gère les téléversements pour les sources `path`, `bytes` et `url`.
  Pour un contrôle de téléversement plus bas niveau, utilisez `client.uploads.*`.
</Note>

## Trois types de source

<Tabs>
  <Tab title="Local file">
    ```ts theme={null}
    const operation = await client.projects.create({
      source: { type: "path", path: "./song.mp3" },
    });
    ```
  </Tab>

  <Tab title="In-memory bytes">
    ```ts theme={null}
    const fileBuffer = new Uint8Array([/* audio bytes */]);

    const operation = await client.projects.create({
      source: {
        type: "bytes",
        data: fileBuffer,
        filename: "song.mp3",
      },
    });
    ```
  </Tab>

  <Tab title="Remote URL">
    ```ts theme={null}
    const operation = await client.projects.create({
      source: {
        type: "url",
        url: "https://example.com/song.mp4",
      },
    });
    ```
  </Tab>
</Tabs>

## Et ensuite

* [Projects](/fr/sdk/projects) — API complète des projets
* [Exports](/fr/sdk/exports) — rendu local et `client.exports.prepareLocal`
* [Errors](/fr/sdk/errors) — gérer `YoukaRequestError` et `YoukaTaskError`
* [AI agents](/fr/agents) — modèles recommandés de polling et de retry