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

​
Установка

npm install @youka/sdk

​
Требования

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

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

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

​
Справочник

Быстрый старт

Сквозной пример: создать, дождаться, экспортировать, скачать.

Аутентификация

Настройка YoukaClient и безопасная работа с API-ключами.

Аккаунт, кредиты и биллинг

Идентификация, баланс, цены, оформление оплаты и помощники портала биллинга.

Проекты

Загрузки, создание, список и удаление.

Stems

Запуск задач по разделению на stems.

Синхронизация текста

Повторный запуск синхронизации текста.

Экспорт

Рабочие процессы экспорта в облаке и локально.

Задачи

Просмотр задач и ожидание завершения.

Пресеты

Переиспользуемые конфигурации рендера.

Медиа

Загрузка фонов, логотипов и интро.

Настройки проекта

Настройки рендера на уровне проекта.

Ошибки

YoukaRequestError и YoukaTaskError.

​
Что дальше

  • Быстрый старт — самый короткий путь к готовому караоке
  • Справочник API — все эндпоинты, автоматически сгенерированные из OpenAPI
  • AI agents — правила работы для авторов агентов