API Reference

---

鉴权方式

BioF3 API 使用三种鉴权方式，按优先级依次尝试：

1. JWT Bearer Token（用户登录）

Authorization: Bearer <jwt>

通过 POST /api/platform/auth/login 获取 token，前端存储后附加到所有请求。

2. Legacy API Token（管理员/兼容）

X-API-Token: <token>

或通过 query string：?token=<token>

仅用于管理员脚本和内部兼容路径。

3. Internal Token（ECS ↔ Dell 内部调用）

X-BioF3-Internal-Token: <token>

仅当两端都配置了 BIOF3_INTERNAL_TOKEN 环境变量且非空时启用。用于 ECS platform 向 Dell compute 节点的内部代理请求。

API 前缀

生产环境通过 nginx 路由分流为三个前缀：

前缀	目标	说明
/api/platform/*	ECS platform-server (:3011)	控制面：auth / data / ai / tools / admin
/api/r/*	Dell r-server (:3001)	R compute：任务执行 / 即时运行
/api/py/*	Dell py-server (:3002)	Python compute：任务执行 / 即时运行

SSE（Server-Sent Events）端点

以下端点返回 text/event-stream 流，需要用 EventSource 或 fetch + ReadableStream 消费：

• POST /api/platform/ai/agent — AI Agent 多轮工具调用
• POST /api/platform/ai/chat — AI Chat 流式对话

SSE 事件类型

事件	说明
iter	增量文本输出
tool_call	工具调用开始
tool_result	工具返回结果
conversation	会话元数据
done	流结束

这两个端点支持匿名访问（不携带 token 时按访客处理），由 moduleGate 决定实际权限。

匿名访问端点

以下端点无需鉴权（security: []）：

• GET /api/platform/health
• GET /api/r/api/health
• GET /api/py/api/health
• GET /api/platform/public/guest-permissions
• POST /api/platform/feedback
• POST /api/platform/error-report
• POST /api/platform/pageview
• GET /api/r/tools/public-demo/{jobId}

OpenAPI Spec

完整的 OpenAPI 3.0.3 规范文件位于：

static/openapi/biof3-public.yaml

可用于生成客户端 SDK、Mock 服务或导入 API 测试工具。