Skip to content

REST API reference

The FastAPI server (title QuOptuna Next API) serves interactive OpenAPI docs at http://localhost:8000/api/docs. Treat those docs as the source of truth for request and response schemas.

MethodPathPurpose
GET/healthHealth check
GET/infoServer info
GET/modelsList available model types
MethodPathPurpose
POST/uploadCSV upload
GET/uciList UCI datasets
POST/uci/{dataset_id}/loadLoad a UCI dataset
GET/uci/{dataset_id}UCI dataset metadata
GET/{dataset_id}/previewPreview dataset rows
GET/{dataset_id}Dataset details
MethodPathPurpose
POST/Start a run (background task)
GET/List runs
GET/{optimization_id}Run status
GET/{optimization_id}/detailRun detail
GET/{optimization_id}/trialsLive trial polling
DELETE/{optimization_id}Cancel / delete run

The main request contract is the OptimizationRequest (dataset, features, target, model set, sampler/pruner, fairness, encoding, device). Refer to /api/docs for its full schema.

MethodPathPurpose
POST/jobsStart an async analysis job
GET/jobs/{job_id}Analysis job status
GET/snapshotsList snapshots
GET/snapshots/{id}Snapshot detail
GET/snapshots/{id}/reportsSnapshot reports
POST/snapshots/{id}/fairnessSnapshot fairness audit
POST/shapSHAP analysis
POST/shap/dataSHAP plot data
POST/metricsMetrics
POST/curvesCurves
POST/curves/dataCurve plot data
POST/confusion-matrix/dataConfusion-matrix data
POST/feature-importance/dataFeature-importance data
POST/study-plotsOptuna study plots
POST/fairnessFairness metrics
POST/reportAI report
MethodPathPurpose
GET/loginBegin Auth0 login
GET/callbackAuth0 callback
GET/logoutLog out
GET/profileAuthenticated user profile