MADSci provides 7 manager services, each with a REST API built on FastAPI. Click any manager below to view its full interactive API documentation.
Manager APIs¶
| Manager | Default Port | API Docs | OpenAPI Spec |
|---|---|---|---|
| Lab Manager | 8000 | View API | JSON |
| Event Manager | 8001 | View API | JSON |
| Experiment Manager | 8002 | View API | JSON |
| Resource Manager | 8003 | View API | JSON |
| Data Manager | 8004 | View API | JSON |
| Workcell Manager | 8005 | View API | JSON |
| Location Manager | 8006 | View API | JSON |
Common Endpoints¶
All managers expose these standard endpoints:
GET /health-- Health check with status and version infoGET /settings-- Current manager settings (secrets redacted)
Live Documentation¶
When running locally, each manager also serves interactive docs at:
Swagger UI:
http://localhost:{port}/docsReDoc:
http://localhost:{port}/redoc
Regenerating API Specs¶
To update the API specs after modifying endpoints:
just api-specs # Export OpenAPI JSON specs
just rest-api-docs # Generate Redoc HTML pages (includes api-specs)