Web API Reference¶
The amorphouspy-api is a FastAPI-based service that provides a Model Context Protocol (MCP) interface for running oxide glass simulations with intelligent caching.
Environment Variables¶
| Variable | Description | Default |
|---|---|---|
EXECUTOR_TYPE |
Executor backend: test, slurm, flux, or single |
test |
SLURM_PARTITION |
SLURM partition name (slurm only) | - |
SLURM_RUN_TIME_MAX |
Max run time per job in seconds (slurm only) | - |
SLURM_MEMORY_MAX |
Max memory per job in GB (slurm only) | - |
AMORPHOUSPY_PROJECTS |
Directory for project/cache files | ./projects |
API_BASE_URL |
Public base URL used in visualization and result links returned by the API. Must be set for URLs to be absolute. | (empty) |
API_TOKEN |
Bearer token for API authentication. If not set, the API runs without authentication (a warning is logged). When set, requests must include Authorization: Bearer <token>. |
- |
Endpoint Reference¶
Complete endpoint reference created from the OpenAPI schema, as found on /docs of the running API.