REFERENCE / 03

API 路由与配置参考

下面是接口约定和配置要点。完整可复制的 Wrangler 示例、curl 和 KV 数据结构请结合仓库 README 使用。

完整版 HTTP 路由

GET / · /index.html

用户注册页面。

POST /signup · GET /signup-status?email=...

申请激活与轮询注册状态。

GET /admin/login · GET/POST /admin

管理员登录及后台入口。

GET /admin/api/users · GET /admin/api/knowledge

查询用户与知识库信息。

POST /admin/api/action · /admin/api/add-knowledge · /admin/api/test-connection

管理操作、上传知识、上游连接测试。

POST /v1/chat/completions

对外 OpenAI 兼容聊天请求路径;其他非保留路径会进入代理逻辑。

环境变量与绑定

基础(两种模式)

USER_KEYS_KV · UPSTREAM_BASE_URL · REAL_API_KEY · UPSTREAM_MODEL_ID · REQUIRED_MODEL_NAME · QUOTA_PER_USER_PER_MONTH

完整版专用

KNOWLEDGE_D1 · ADMIN_PASSWORD · ADMIN_USERNAME · LIMIT_PER_IP_PER_MONTH · DAILY_LIMIT · REQUIRED_MODEL_NAME_2

第二上游(可选)

UPSTREAM_BASE_URL_2 · REAL_API_KEY_2 · UPSTREAM_MODEL_ID_2

检索上游(可选)

UPSTREAM_EMBEDDING_BASE_URL · REAL_EMBEDDING_API_KEY · EMBEDDING_MODEL_ID,以及相应的 _2 变量。

KV 约定

用户与注册

userkey:<email> · activation:<code> · pending:<email>(900 秒) · signup_ip:<ip>:<yyyy-mm>

用量与配置

quota:<email>:<yyyy-mm> · api1_daily_count:<yyyy-mm-dd> · config:load_balancing_enabled · config:retrieval_prompt

内容依据 cfRelay 主分支 README 整理。涉及部署时,请以源代码为最终依据。查看完整 README ↗