메인 콘텐츠로 건너뛰기
@youka/sdk는 Youka API를 위한 공식 TypeScript SDK입니다. 이를 사용해 오디오 또는 비디오에서 가라오케를 만들고, 가사와 스타일링을 커스터마이즈하며, MP4 비디오를 내보내고, Youka 워크플로를 Node.js 또는 Bun 앱에 통합할 수 있습니다.

​
설치

npm install @youka/sdk

​
요구 사항

  • Node.js 20 이상 또는 Bun 1.1+
  • YOUKA_API_KEY에 설정된 Youka API 키( API keys 아래의 online.youka.io/account에서 생성)

​
빠른 예시

import { YoukaClient } from "@youka/ko/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);

​
레퍼런스

Quickstart

엔드투엔드 예시: 생성, 대기, 내보내기, 다운로드.

Authentication

YoukaClient를 구성하고 API 키를 안전하게 처리하세요.

Account, credits, and billing

신원, 잔액, 가격, 결제, 청구 포털 헬퍼.

Projects

업로드, 생성, 목록 조회, 삭제.

Stems

스템 분리 작업을 트리거합니다.

Lyrics sync

가사 동기화를 다시 실행합니다.

Exports

클라우드 및 로컬 내보내기 워크플로.

Tasks

작업을 확인하고 완료될 때까지 대기합니다.

Presets

재사용 가능한 렌더 구성.

Media

배경, 로고, 인트로를 업로드합니다.

Project settings

프로젝트 수준의 렌더 설정.

Errors

YoukaRequestError 및 YoukaTaskError.

​
다음 단계

  • Quickstart — 완성된 가라오케로 가는 가장 빠른 경로
  • API reference — OpenAPI에서 자동 생성된 모든 엔드포인트
  • AI agents — 에이전트 작성자를 위한 운영 규칙