API Documentation

RESTful API for programmatic NHANES analysis

Base URL: http://localhost:8501 (local) | Version: 2.0.0

Endpoints

POST/api/projects Create analysis project

Parameters: title, description, exposure, outcome, cycles, analysis_type, proposal_file

curl -X POST http://localhost:8501/api/projects \
  -F "title=BMI and Hypertension" \
  -F "exposure=BMXBMI" -F "outcome=BPQ020"
POST/api/projects/{id}/run Run analysis pipeline
GET/api/projects/{id}/status Check analysis status
GET/api/projects/{id}/results Get analysis results
GET/api/variables/search?q={query} Search NHANES variables
GET/api/variables/phenotype/{name} Get phenotype variables
GET/api/pubmed/search?q={query} Search PubMed literature
POST/api/demo/{type} Run demo analysis

Demo types: bmi_hypertension, diabetes_cvd, depression_sleep