Saltar para o conteúdo principal
@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

npm install @youka/sdk

​
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 em API keys)

​
Exemplo rápido

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

Início rápido

Exemplo de ponta a ponta: criar, aguardar, exportar, baixar.

Autenticação

Configure o YoukaClient e lide com chaves de API com segurança.

Conta, créditos e faturamento

Identidade, saldo, preços, checkout e helpers do portal de faturamento.

Projetos

Uploads, criação, listagem e exclusão.

Stems

Dispare tarefas de separação de stems.

Sincronização de letras

Execute novamente a sincronização de letras.

Exportações

Workflows de exportação na nuvem e local.

Tarefas

Inspecione tarefas e aguarde a conclusão.

Presets

Configurações de render reutilizáveis.

Mídia

Faça upload de fundos, logotipos e intros.

Configurações do projeto

Configurações de render no nível do projeto.

Erros

YoukaRequestError e YoukaTaskError.

​
Próximos passos