Skip to content

api-reference.md

Latest commit

 

History

History
40 lines (28 loc) · 2.97 KB

api-reference.md

File metadata and controls

40 lines (28 loc) · 2.97 KB
Raw

API 速查

接口以 cmd/server/routes.go 为准。管理端先添加账号并创建 API Key；以下模型/推理接口需要 Authorization: Bearer <API_KEY>，Anthropic 客户端也可使用 x-api-key。只有 anonymous_allow_ips 显式允许的来源可免 Key；已废弃的 inference_auth_enabled 配置会被忽略。

推理与模型

前缀 适用范围
/v1 按 model 自动选择通道
/workbuddy/v1、/qoder/v1、/cline/v1、/grok/v1 固定通道

上述前缀提供 POST /messages、POST /chat/completions、POST /responses、GET /models 和 GET /models/{id}；统一前缀及 WorkBuddy、Qoder、Cline 前缀还提供 POST /messages/count_tokens 估算 token。Responses 对 Grok 使用 Build 原生实现，其他通道桥接 Chat Completions；可用 GET/DELETE /responses/{id} 管理已存响应，以及 POST /responses/{id}/cancel、GET /responses/{id}/input_items。Grok 和统一前缀还支持 POST /responses/compact。具体能力仍取决于模型与上游。

curl http://127.0.0.1:3002/v1/chat/completions \
  -H 'Authorization: Bearer <API_KEY>' -H 'Content-Type: application/json' \
  -d '{"model":"<MODEL_ID>","messages":[{"role":"user","content":"你好"}]}'

GET /health 用于健康检查；GET /metrics 提供 Prometheus 指标，生产环境建议只对内开放。

管理端

访问 {admin_path}/ 登录。管理接口使用管理会话（或支持时使用 Basic Auth），不能以推理 API Key 代替管理身份。

接口 用途
POST /api/login、POST /api/logout 管理会话
/api/accounts* 账号管理
/api/keys* 创建、更新、禁用与删除推理 API Key
/api/models* 模型管理；POST /api/models/refresh 按通道刷新
/api/config* 配置管理
POST /api/workbuddy/login、POST /api/qoder/login、POST /api/cline/login 发起相应渠道官方授权
POST /api/grok/device-auth 发起 Grok Build OAuth 设备授权

登录事务创建后，在返回的官方授权页面完成操作，通过对应 GET /api/{channel}/login/{id}（Grok：GET /api/grok/device-auth/{id}）轮询；同路径的 DELETE 可取消。管理页面已集成流程，建议直接在页面操作。Qoder、Cline、Grok 不接受手填个人 token；WorkBuddy 的凭据导入仅用于迁移。

模型刷新示例（需已登录的管理会话）：POST /api/models/refresh，JSON 请求体 {"channel":"qoder"}。只有成功读取上游目录时才同步；读取失败会保留原有目录，不回退到内置模型。不同通道的上游目录分别来自 WorkBuddy /v3/config、Qoder /algo/api/v2/model/list、Cline /ai/cline/recommended-models（免费推荐列表）和 Grok Build /v1/models。

API Key 可设置允许模型、限速和过期策略；请求报错时先检查 Key、账号状态、模型目录与上游响应。更多配置见 配置说明。