# YiAPI 文档全文

> 这是 YiAPI 文档站的 LLM 版摘要。真实页面以后会继续补截图和更具体步骤。

## 什么是 YiAPI

YiAPI 是 AI 订阅平台。用户不需要自己订阅 Claude/GPT，通过 YiAPI Key 就能在客户端、CLI 或自己的工具里按量使用各种 AI 模型。YiAPI 按量付费，随用随充。文档主要面向基础用户，当前优先讲如何创建密钥、下载客户端并配置客户端。

## 快速开始

用户先在 YiAPI 创建密钥，再下载桌面客户端。新手优先推荐 Codex App。配置客户端时通常需要填写 YiAPI Key、Base URL 和模型名。失败时先检查 Key、Base URL、模型名、余额和额度。

## 工具页通用结构

每篇工具页都说明：

- 是否支持自定义 API Key
- API 类型是 OpenAI Compatible、Anthropic Compatible，还是待确认
- 是否需要 Base URL
- 如何在 App 设置里找到 Provider、API Key、Base URL、Model
- 如何用一句简单问题测试是否成功
- 如何更换或删除 Key

## 页面列表

### 什么是 YiAPI

URL: https://docs.yiapi.ai/docs/what-is-yiapi

了解 YiAPI 这个 AI 订阅平台能帮你做什么。

### 快速开始

URL: https://docs.yiapi.ai/docs/getting-started

创建密钥、下载客户端、配置客户端。

### Codex App

URL: https://docs.yiapi.ai/docs/tools/codex-app

在 Codex 桌面应用中配置 YiAPI Key。

### Claude Code App

URL: https://docs.yiapi.ai/docs/tools/claude-code-app

在 Claude Code 图形界面里使用 YiAPI。

### Trae Work

URL: https://docs.yiapi.ai/docs/tools/trae-work

在 Trae Work 中确认是否支持自定义 API Key。

### WorkBuddy

URL: https://docs.yiapi.ai/docs/tools/workbuddy

WorkBuddy 的 YiAPI 接入说明。

### CC Switch

URL: https://docs.yiapi.ai/docs/cc-switch

CC Switch 的使用说明。