Introduction
epydemix Web API is a REST API for running epidemic simulations powered by epydemix.
Overview
The API exposes epydemix's simulation engine over HTTP. You can run compartmental models (SIR, SEIR, SIS) against built-in population data by sending a single JSON request. No Python environment required on the client side.
How it works
- Pick a model preset and population
- POST a simulation request with your parameters
- Get back compartment trajectories for each simulation run
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /api/v1/simulations | Run a simulation |
| GET | /api/v1/populations | List available populations |
| GET | /api/v1/populations/{name} | Get population details |
| GET | /api/v1/populations/{name}/contacts | Get contact matrices |
| GET | /api/v1/models/presets | List model presets |
| GET | /api/v1/health | Health check |
The API Reference has interactive docs where you can explore schemas and send requests directly.