> ## Documentation Index
> Fetch the complete documentation index at: https://docs.youka.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API 概览

> 基于项目的 API，用于上传、异步任务、预设、媒体、项目设置和导出。

# API 概览

Youka API 是一个基于项目的 API，用于自动化卡拉 OK 制作。

使用 `v1` 你可以：

* 验证已认证账户并查看点数余额。
* 创建计费结账页和门户的 URL。
* 上传源媒体。
* 创建项目。
* 在创建项目或进行云端导出前，预估点数消耗。
* 运行音轨分离。
* 运行歌词同步。
* 管理预设和媒体。
* 更新当前项目的活跃设置。
* 导出完成的卡拉 OK 视频。
* 轮询异步任务状态。

所有自动化均使用 API key。

如果你使用 Node.js 或 Bun 开发，建议从 SDK 开始。需要直接使用 cURL 或自定义客户端示例时，再参考原始 HTTP 指南。

## Base URL

```text theme={null}
https://api.youka.io/zh/api/v1
```

## 接下来阅读

* [Node.js SDK quickstart](/zh/sdk)
* [Raw HTTP quickstart](/zh/api/quickstart)
* [Authentication](/zh/api/authentication)
* [Async jobs](/zh/api/async-jobs)
* [Idempotency](/zh/api/idempotency)
* [Errors and retries](/zh/api/errors)
