BorderCollie
免费试用
REST API

API 参考

所有官网与控制台用到的接口都是公开的 REST，base URL 见下。

BorderCollie 控制台猫狗试验室
已同步
API 调用面板公开接口、登录态接口、CLI Key
GET/api/v1/system/version公开
POST/api/v1/review/scan登录态
GET/api/v1/cli/whoamiAPI Key
10000000OK
base urlhttps://review.woofcloud.com/api/v1

需要鉴权的接口请在请求头加 Authorization: Bearer <access_token>；登录返回的 access_token 有效期 2 小时，可用 /api/v1/token/** 续期。

公开接口

POST/api/v1/user/register用户注册（邮箱或手机号）
POST/api/v1/captcha/send发送邮箱/短信验证码
GET/api/v1/system/version系统版本信息（changelog 数据源）
GET/api/v1/announcement/public/page官网公告分页查询
GET/api/v1/announcement/public/:slug官网公告详情
GET/api/v1/subscription/plans公开套餐目录
POST/api/v1/webhook/:platform统一 Webhook 入口（platform=github/gitlab/gitee/cnb）

登录态接口

POST/api/v1/login账号密码登录
GET/api/v1/menu当前用户菜单 / 权限
POST/api/v1/review/repo保存仓库配置
GET/api/v1/review/task/page审查任务分页查询
POST/api/v1/review/scan触发一次仓库扫描

CLI 与 CI 接入

GET/api/v1/cli/whoamiCLI：查询当前 API Key 绑定的租户与套餐
GET/api/v1/cli/repo/listCLI：列当前租户的仓库
POST/api/v1/cli/repoCLI：新建或更新仓库
DELETE/api/v1/cli/repo/:idCLI：删除仓库
PUT/api/v1/cli/repo/:id/toggleCLI：切换仓库启用状态
GET/api/v1/cli/model/listCLI：列模型
POST/api/v1/cli/modelCLI：新建或更新模型
PUT/api/v1/cli/model/:id/defaultCLI：设为默认模型
GET/api/v1/cli/agent/listCLI：列已启用的审查角色
PUT/api/v1/cli/agent/:id/toggleCLI：切换审查角色启用状态
GET/api/v1/cli/reviewer/listCLI：列审核人员（含内置预设）
POST/api/v1/cli/review/submitCLI：提交本地 diff 跑一次审查
POST/api/v1/cli/review/branchCLI：让后端拉 base..branch 的 diff 跑审查
GET/api/v1/cli/review/status/:idCLI：查询任务简洁状态
GET/api/v1/cli/review/result/:idCLI：查询任务详细结果（含 findings）
GET/api/v1/cli/review/listCLI：最近任务分页
POST/api/v1/cli/review/:id/retryCLI：重试失败任务
GET/api/v1/cli/usageCLI：查看当前租户的配额与用量
GET/api/v1/cli/plansCLI：列出对外公开的套餐目录
GET/api/v1/cli/logs/pageCLI：模型调用日志分页

CLI 与 CI 通过请求头 X-API-Key 鉴权；API Key 在控制台「API Key」页签生成，按租户隔离。

更详细的字段约束、错误码与示例请见 /docs