1 · 安装与注册

1.1 注册 VOLO AI 账号

打开浏览器访问 volo.ai，点右上角 Sign Up。

支持三种登录方式（均来自后端 AuthController）：

方式	说明	路径
邮箱 + 密码	标准注册，需邮箱验证码	POST /api/auth/register
邮箱验证码	免密码登录	POST /api/auth/login/email
Google OAuth	一键登录	POST /api/auth/oauth2/google

邮箱验证码流程

1. POST /api/auth/email/send 发送验证码到邮箱
2. 在控制台输入六位数字验证码
3. 注册成功，自动登录

---

1.2 获取 API Key

注册成功后，进入 Console → Settings → API Keys：

1. 点 Create New Key
2. 命名（如 quickstart-key）
3. 复制生成的密钥 —— 只展示一次，立刻保存

API Key 格式：volo-sk- 开头的字符串。

API Key 视为密码保管

• 不要提交到 Git 仓库
• 不要硬编码到前端代码（暴露给用户浏览器）
• 推荐用环境变量：export VOLO_API_KEY=volo-sk-...
• 怀疑泄漏立刻在控制台 Revoke

---

1.3 安装 SDK

TypeScript / Node

npm install @volo-ai/sdk
# 或
pnpm add @volo-ai/sdk
# 或
yarn add @volo-ai/sdk

Python

pip install volo-ai
# 或
poetry add volo-ai

Java / Maven

# pom.xml
<dependency>
  <groupId>ai.volo</groupId>
  <artifactId>volo-ai-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

Go

go get github.com/volo-ai/volo-go

SDK 包名待发布

当前 SDK 实现以 TypeScript (frontend/src/volo-ai-ctrl-kit) 为权威源，正在打包发布为公开 npm 包。Python / Java / Go SDK 按 TS 接口规范实现中。
[TODO: 公开包名发布时间待定]
在 SDK 发布前，可参考 API Reference 直接调用 REST/SSE 端点。

---

1.4 验证 API Key

在终端跑一行 curl，确认 API Key 生效：

curl -X GET https://api.volo.ai/api/auth/me \
  -H "Authorization: Bearer $VOLO_API_KEY"

预期返回：

{
  "code": 200,
  "message": "success",
  "data": {
    "userId": "uuid-...",
    "email": "you@example.com",
    "nickname": "your-nickname",
    "tier": "free",
    "credits": 100.00
  }
}

看到 401？

检查 $VOLO_API_KEY 是否正确导入，或确认 Key 未被 Revoke。

---

下一步 → 第一次 API 调用