The FastAPI server (title QuOptuna Next API ) serves interactive OpenAPI docs at http://localhost:8000/api/docs/api/redoc). Treat those docs as the source of truth for request and response schemas. GET /api returns basic API metadata.
All /api/v1/* routes except /api/v1/health require an authenticated user only when Auth0 is configured . When Auth0 is unset, the API is open (suitable for local/dev). /auth/*, /api/v1/health and the OpenAPI docs are always open. See Configuration reference .
Method Path Purpose GET /healthHealth check GET /infoServer info GET /modelsList available model types
Method Path Purpose POST /uploadCSV upload (.csv files only) 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
Method Path Purpose 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/api/docs
Method Path Purpose POST /jobsStart an async analysis job GET /jobs?optimization_id=…Active (pending/running) job for a run, or null — lets a client reattach after a refresh GET /jobs/{job_id}Analysis job status POST /jobs/{job_id}/cancelRequest cooperative cancellation of a running job GET /snapshots?optimization_id=…List snapshots for a run GET /snapshots/{id}Snapshot detail GET /snapshots/{id}/revisionsList snapshot revisions GET /snapshots/{id}/revisions/{revision}Snapshot revision detail GET /snapshots/{id}/artifacts/{filename}Download a snapshot artifact GET /snapshots/{id}/reportsSnapshot reports GET /snapshots/{id}/contextReport context (include_evidence_markdown, default true) GET /snapshots/{id}/bundleDownload the research bundle (ZIP) POST /snapshots/{id}/fairnessSnapshot fairness audit POST /bundles/bulkLatest completed research bundles for several runs in one ZIP 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 GET /report-promptsDefault report-agent prompts and settings POST /reportAI report
Method Path Purpose GET /loginBegin Auth0 login GET /callbackAuth0 callback GET /logoutLog out GET /profileAuthenticated user profile
