BioFlow API Quickstart
Provide a concise implementation/use checklist for BioFlow APIs with minimal context loading.
Workflow
- 1. Read references/current-auth-map.md for project scope and auth/token model.
- Read references/api-call-flow.md for concise API call sequence (signup/login -> upload -> balance -> create task -> poll -> results -> download).
- Use one algorithm path for demo execution (default PTMPred) instead of mixing multiple algorithms in one run.
- Keep responses concise: show endpoint, required params, minimal request example, and key response fields only.
Output Structure
- 1. Project intro: base URL, auth mode, major API groups.
- Registration/login: send SMS verification code, signup (telephone + verification_code), login, refresh, me.
- File workflow: upload dataset and get dataset download URL.
- Balance query:
GET /api/v1/token/balance. - Task submission: one concrete algorithm endpoint and required parameters.
- Result query: job detail, results list, and result download endpoint.
Done Criteria
- 1. Agent can explain complete API path from account creation to result retrieval in one compact response.
- Endpoint examples are executable with current Bearer token flow.
- File upload/download and task/result endpoints are both covered.
References
- 1. references/current-auth-map.md
- references/api-call-flow.md
BioFlow API 快速入门
提供一份简洁的BioFlow API实施/使用清单，尽量减少上下文加载。
工作流程
- 1. 阅读references/current-auth-map.md了解项目范围及认证/令牌模型。
- 阅读references/api-call-flow.md了解简洁的API调用顺序（注册/登录 -> 上传 -> 余额查询 -> 创建任务 -> 轮询 -> 结果 -> 下载）。
- 演示执行时使用单一算法路径（默认PTMPred），避免在一次运行中混合多种算法。
- 保持响应简洁：仅展示端点、必需参数、最小请求示例及关键响应字段。
输出结构
- 1. 项目介绍：基础URL、认证模式、主要API分组。
- 注册/登录：发送短信验证码、注册（手机号+验证码）、登录、刷新令牌、个人信息查询。
- 文件工作流：上传数据集并获取数据集下载URL。
- 余额查询：GET /api/v1/token/balance。
- 任务提交：一个具体算法端点及必需参数。
- 结果查询：任务详情、结果列表及结果下载端点。
完成标准
- 1. 智能体能够在一个紧凑的响应中解释从账户创建到结果检索的完整API路径。
- 端点示例可在当前Bearer令牌流程下执行。
- 文件上传/下载及任务/结果端点均已覆盖。
参考资料
- 1. references/current-auth-map.md
- references/api-call-flow.md
