A reference for the HTTP endpoints the AirInduct Sim web and mobile apps call. They are not a supported public REST API; for programmatic access from scripts and AI agents, use the MCP server with an API key.
Use your deployed backend domain as the base URL for all endpoints.
https://<your-backend-domain>
| Method | Path | Rate limit | Description |
|---|---|---|---|
| GET | /health | 60/minute | Service health verification endpoint used for uptime checks. |
| POST | /api/helmholtz | 30/minute | Case 1 simulation endpoint with optional 3D volume and vector field modes. |
| POST | /api/square_dtc_helmholtz | 30/minute | Case 2 endpoint for distributed transmitter and Helmholtz receiver configurations. |
| POST | /api/square_helmholtz_dtc | 30/minute | Case 3 endpoint for Helmholtz transmitter and distributed receiver configurations. |
| POST | /api/square_dtc_dtc | 30/minute | Case 4 endpoint for distributed transmitter and distributed receiver studies. |
| POST | /api/sweep | 10/minute | Parameter-sweep endpoint for precomputing animation frames across a value range. |
| POST | /api/export/pdf | default limiter | Generate printable PDF reports for simulation outputs. |
| POST | /api/export/cad | default limiter | Generate CAD exports for downstream engineering workflows. |
| POST | /api/helmholtz/animation | default limiter | Animation payload generation for Case 1. |
| POST | /api/square_dtc_helmholtz/animation | default limiter | Animation payload generation for Case 2. |
| POST | /api/square_helmholtz_dtc/animation | default limiter | Animation payload generation for Case 3. |
| POST | /api/square_dtc_dtc/animation | default limiter | Animation payload generation for Case 4. |
Compatible with /api/helmholtz, /api/square_dtc_helmholtz, /api/square_helmholtz_dtc, and /api/square_dtc_dtc.
{
"I": 1,
"Ic": 1,
"amax": 0.1,
"h": 0.05,
"xt": 0,
"yt": 0,
"zt": 0,
"Nr": 5,
"R": 25,
"xlim": 100,
"f": 6780000,
"resolution": 20,
"mode": "2d_plane"
}Use /api/sweep to generate parameter-sweep animation frames.
{
"case_type": "helmholtz",
"base_params": {
"I": 1,
"Ic": 1,
"amax": 0.1,
"h": 0.05,
"xt": 0,
"yt": 0,
"zt": 0,
"Nr": 5,
"R": 25,
"xlim": 100,
"f": 6780000,
"resolution": 20
},
"sweep_param": "h",
"sweep_start": 0.02,
"sweep_end": 0.10,
"sweep_steps": 10
}Standard responses include field arrays (Hx, Hy, Hz), scalar metrics (Vout, M, L_tx, L_rx), and grid coordinates (X, Y, Z). 3D payloads are gzip-compressed for transfer efficiency.
The AirInduct Sim MCP server at https://api.airinductsim.com/mcp/ is the supported programmatic interface. It exposes the same tools as the in-app Copilot — simulations, sweeps, link analysis, exposure checks and design search — authenticated with an API key from your account.