Skip to main content
项目包含卡拉OK或歌词视频的源媒体、歌词、渲染设置以及导出内容。卡拉OK项目还包含分离后的音轨(stems)。

project create

从本地文件或 URL 创建一个新项目。
string
required
本地文件路径(./song.mp3)或 HTTP/HTTPS URL (https://example.com/song.mp4)。

Options

Examples

规则:
  • 如果你传入了歌词但省略 --mode,CLI 默认使用 align
  • align 需要歌词
  • transcribe 可接受可选的参考歌词。模型可能会返回不同的文本。
  • none 不接受歌词
  • --kind lyric-video 使用原始音频而不进行音轨分离,并会拒绝 --split-model。省略 --kind 会保留卡拉 OK 的行为。
  • --download 会隐式包含 --export
  • --max-video-quality 仅适用于 HTTP/HTTPS 的 URL 源。默认是 1080p,会在该上限内使用可用的最佳质量;当平台不提供受限码流时,会回退到可用的最佳格式。

project list

列出已认证账号下的所有项目。

project quote

在不创建项目的情况下,估算创建项目所需的点数(credits)。
source 接受与 project create 相同的本地文件路径或 HTTP/HTTPS URL 形式。若未提供 --duration,CLI 会上传源文件以便服务器精确测量媒体时长,但不会创建项目。

Options

Examples:

project show

获取当前项目状态,包括规范化后的 state、pendingOperation、音轨(stems)、设置和导出内容。
string
required
由 project create 返回的项目 ID。

project wait

轮询项目直到进入终态(terminal state)。

project delete

删除项目以及其关联的所有音轨、歌词和导出内容。
删除是永久性的。传入 --idempotency-key 可确保重试安全。

project sync

对现有项目重新执行歌词转写或对齐。
Example:

project separate

对现有项目重新执行音轨分离。
Example:

project settings

读取或更新当前启用的项目设置。
如果既没有 --preset 也没有 --body,该命令会返回当前设置;如果提供了其中任意一个,则会执行更新。 Examples:

project stem list

列出项目的音轨(stems)。

project stem download

将一个或多个音轨文件下载到磁盘。音轨会以其原始存储格式下载;CLI 不会对其进行转码。
支持的 --type 值为 original、instrumental、vocals 和 backing_vocals。CLI 也接受 backing-vocals、backingVocals 和 backingvocals 作为别名。

What’s next

Capabilities, versions, and timings

youka capabilities --json 会返回模型 ID、支持的工作流、文本处理方式、语言支持和账号可用性。Wav2Vec2 是对齐模型。ElevenLabs Scribe 是转写模型。需要人声隔离的模型必须使用带有分离模型(能生成 vocals)的卡拉 OK 工作流。
project settings --version-id 会读取或更新所选版本。省略该标志则使用主版本(primary version)。 Timing 导入会在不触发处理任务或点数冻结(credit hold)的情况下替换完整对齐结果。JSON body 包含 alignment 和 expectedRevision。原子性的保存并选中(atomic save-and-select)还需要 select: true 和 expectedSelectionRevision。过期的 token 会返回 HTTP 409。在尝试再次编辑之前,请先获取并对比当前值。 关于请求文件、timing 校验以及可恢复的目录处理,请参阅 Automate lyric videos。