Endpoint Reference
Analysis endpoints
Section titled “Analysis endpoints”POST /analyses: upload evidence and start processing.GET /analyses/{id}: poll analysis status and summary results.GET /analyses/{id}/peaks: return the full peak table.GET /analyses/{id}/report: download a reviewed report.
POST /analyses is the first canonical endpoint in the OpenAPI schema. It accepts multipart form data with:
| Field | Required | Notes |
|---|---|---|
fid_file | Yes | Raw FID binary or accepted source evidence file. |
acqus_file | Required for Bruker | Acquisition parameter file required for Bruker FID interpretation. |
nucleus | Yes | 1H, 13C, or 2D. |
instrument | Yes | bruker, agilent, or jcamp_dx. |
project_id | No | Attach the analysis to an existing project. |
notes | No | Human-readable context for the review record. |
Optimization endpoints
Section titled “Optimization endpoints”POST /optimizations: create a Bayesian optimization run.POST /optimizations/{id}/iterations: submit an experiment result.GET /optimizations/{id}/recommendation: fetch the next recommended experiment.
Project and regulatory endpoints
Section titled “Project and regulatory endpoints”GET /projects: list projects.POST /projects: create a project.GET /regulatory/thresholds: look up ICH threshold context.
Endpoint details should be generated from the OpenAPI schema and reviewed by the backend owner.
Documentation rule
Section titled “Documentation rule”For each endpoint, document the HTTP method, path, description, request body schema, response schema, error schema, and a tested curl example. Validate the YAML before release, then test the documented request against sandbox.