Skip to main content
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 em API keys)
  • Um arquivo de áudio local (./song.mp3) ou uma URL remota

​
Instalar

npm install @youka/sdk

​
Criar, aguardar, exportar

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;
});
client.projects.create() lida com uploads para fontes path, bytes e url. Para um controle de upload mais baixo nível, use client.uploads.*.

​
Três tipos de fonte

const operation = await client.projects.create({
  source: { type: "path", path: "./song.mp3" },
});

​
Próximos passos

  • Projects — API completa de projetos
  • Exports — renderização local e client.exports.prepareLocal
  • Errors — trate YoukaRequestError e YoukaTaskError
  • AI agents — padrões recomendados de polling e retry