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

> Автоматизируйте Youka из Node.js и Bun с официальным TypeScript SDK

`@youka/sdk` — официальный TypeScript SDK для Youka API. Используйте его, чтобы создавать караоке из аудио или видео, настраивать текст и стили, экспортировать MP4-видео и встраивать рабочие процессы Youka в приложения Node.js или Bun.

## Установка

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

## Требования

* Node.js 20 или новее, либо Bun 1.1+
* API-ключ Youka в `YOUKA_API_KEY` (создайте его на [online.youka.io/account](https://online.youka.io/account) в разделе **API keys**)

## Быстрый пример

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

## Справочник

<Columns cols={2}>
  <Card title="Быстрый старт" icon="rocket" href="/ru/sdk/quickstart">
    Сквозной пример: создать, дождаться, экспортировать, скачать.
  </Card>

  <Card title="Аутентификация" icon="key" href="/ru/sdk/authentication">
    Настройка `YoukaClient` и безопасная работа с API-ключами.
  </Card>

  <Card title="Аккаунт, кредиты и биллинг" icon="credit-card" href="/ru/sdk/account-billing">
    Идентификация, баланс, цены, оформление оплаты и помощники портала биллинга.
  </Card>

  <Card title="Проекты" icon="folder" href="/ru/sdk/projects">
    Загрузки, создание, список и удаление.
  </Card>

  <Card title="Stems" icon="waveform-lines" href="/ru/sdk/stems">
    Запуск задач по разделению на stems.
  </Card>

  <Card title="Синхронизация текста" icon="closed-captioning" href="/ru/sdk/lyrics-sync">
    Повторный запуск синхронизации текста.
  </Card>

  <Card title="Экспорт" icon="file-video" href="/ru/sdk/exports">
    Рабочие процессы экспорта в облаке и локально.
  </Card>

  <Card title="Задачи" icon="list-check" href="/ru/sdk/tasks">
    Просмотр задач и ожидание завершения.
  </Card>

  <Card title="Пресеты" icon="palette" href="/ru/sdk/presets">
    Переиспользуемые конфигурации рендера.
  </Card>

  <Card title="Медиа" icon="image" href="/ru/sdk/media">
    Загрузка фонов, логотипов и интро.
  </Card>

  <Card title="Настройки проекта" icon="sliders" href="/ru/sdk/project-settings">
    Настройки рендера на уровне проекта.
  </Card>

  <Card title="Ошибки" icon="triangle-exclamation" href="/ru/sdk/errors">
    `YoukaRequestError` и `YoukaTaskError`.
  </Card>
</Columns>

## Что дальше

* [Быстрый старт](/ru/sdk/quickstart) — самый короткий путь к готовому караоке
* [Справочник API](/ru/api) — все эндпоинты, автоматически сгенерированные из OpenAPI
* [AI agents](/ru/agents) — правила работы для авторов агентов