- name
- bioflow-api-quickstart
- description
- Quick guide for BioFlow backend API usage and integration. Use when an agent needs concise project intro plus end-to-end API flow: signup/login, file upload/download, token balance query, task submission, and result retrieval.
BioFlow API Quickstart
Provide a concise implementation/use checklist for BioFlow APIs with minimal context loading.
Workflow
- 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
- 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
- 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.