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

> Automatize o Youka a partir de Node.js e Bun com o SDK oficial em TypeScript

`@youka/sdk` é o SDK oficial em TypeScript para a API do Youka. Use-o para criar karaokê a partir de áudio ou vídeo, personalizar letras e estilo, exportar vídeos MP4 e integrar workflows do Youka em apps Node.js ou Bun.

## Instalação

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

## Requisitos

* Node.js 20 ou superior, ou Bun 1.1+
* Uma chave da API do Youka em `YOUKA_API_KEY` (crie uma em [online.youka.io/account](https://online.youka.io/account) em **API keys**)

## Exemplo rápido

```ts theme={null}
import { YoukaClient } from "@youka/pt/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);
```

## Referência

<Columns cols={2}>
  <Card title="Início rápido" icon="rocket" href="/pt/sdk/quickstart">
    Exemplo de ponta a ponta: criar, aguardar, exportar, baixar.
  </Card>

  <Card title="Autenticação" icon="key" href="/pt/sdk/authentication">
    Configure o `YoukaClient` e lide com chaves de API com segurança.
  </Card>

  <Card title="Conta, créditos e faturamento" icon="credit-card" href="/pt/sdk/account-billing">
    Identidade, saldo, preços, checkout e helpers do portal de faturamento.
  </Card>

  <Card title="Projetos" icon="folder" href="/pt/sdk/projects">
    Uploads, criação, listagem e exclusão.
  </Card>

  <Card title="Stems" icon="waveform-lines" href="/pt/sdk/stems">
    Dispare tarefas de separação de stems.
  </Card>

  <Card title="Sincronização de letras" icon="closed-captioning" href="/pt/sdk/lyrics-sync">
    Execute novamente a sincronização de letras.
  </Card>

  <Card title="Exportações" icon="file-video" href="/pt/sdk/exports">
    Workflows de exportação na nuvem e local.
  </Card>

  <Card title="Tarefas" icon="list-check" href="/pt/sdk/tasks">
    Inspecione tarefas e aguarde a conclusão.
  </Card>

  <Card title="Presets" icon="palette" href="/pt/sdk/presets">
    Configurações de render reutilizáveis.
  </Card>

  <Card title="Mídia" icon="image" href="/pt/sdk/media">
    Faça upload de fundos, logotipos e intros.
  </Card>

  <Card title="Configurações do projeto" icon="sliders" href="/pt/sdk/project-settings">
    Configurações de render no nível do projeto.
  </Card>

  <Card title="Erros" icon="triangle-exclamation" href="/pt/sdk/errors">
    `YoukaRequestError` e `YoukaTaskError`.
  </Card>
</Columns>

## Próximos passos

* [Início rápido](/pt/sdk/quickstart) — o caminho mais curto para um karaokê finalizado
* [Referência da API](/pt/api) — todos os endpoints, gerados automaticamente a partir do OpenAPI
* [Agentes de IA](/pt/agents) — regras de operação para autores de agentes