AirInduct Sim Developer Platform

API Documentation for Simulation Workflows

Integrate deterministic electromagnetic simulation into research software, internal dashboards, and external products.

Base URL

Use your deployed backend domain as the base URL for all endpoints.

https://<your-backend-domain>

Endpoint Catalog

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.

Case Request Body

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"
}

Sweep Request Body

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
}

Response Surface

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.

MCP Integration Track

The upcoming MCP server will expose simulation tools, schema inspection, and run execution for agentic workflows. Continue using these HTTP endpoints as the underlying compute layer.

View MCP Overview