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

# Início rápido

> Crie um projeto de karaokê, aguarde a conclusão, exporte e baixe o resultado

Este guia mostra o caminho mais rápido, de um arquivo de áudio bruto a um vídeo de karaokê renderizado, usando `@youka/sdk`.

## Antes de começar

* Node.js 20 ou superior
* Uma chave de API da Youka em `YOUKA_API_KEY` (crie uma em [online.youka.io/account](https://online.youka.io/account) em **API keys**)
* Um arquivo de áudio local (`./song.mp3`) ou uma URL remota

## Instalar

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

## Criar, aguardar, exportar

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

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

async function main() {
  // 1. Criar um projeto a partir de um arquivo local
  const projectOperation = await client.projects.create({
    source: { type: "path", path: "./song.mp3" },
    lyricsSource: { type: "transcribe" },
  });

  // 2. Aguarde a separação em stems e a sincronização da letra terminarem
  const { project } = await client.projects.wait(projectOperation);
  console.log("Project ready:", project.id, project.title);

  // 3. Inicie uma exportação
  const exportOperation = await client.exports.create(project.id, {
    resolution: "1080p",
    quality: "high",
  });

  // 4. Aguarde a exportação terminar
  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()` lida com uploads para fontes `path`, `bytes` e `url`.
  Para um controle de upload mais baixo nível, use `client.uploads.*`.
</Note>

## Três tipos de fonte

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

  <Tab title="Bytes em memória">
    ```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="URL remota">
    ```ts theme={null}
    const operation = await client.projects.create({
      source: {
        type: "url",
        url: "https://example.com/song.mp4",
      },
    });
    ```
  </Tab>
</Tabs>

## Próximos passos

* [Projects](/pt/sdk/projects) — API completa de projetos
* [Exports](/pt/sdk/exports) — renderização local e `client.exports.prepareLocal`
* [Errors](/pt/sdk/errors) — trate `YoukaRequestError` e `YoukaTaskError`
* [AI agents](/pt/agents) — padrões recomendados de polling e retry