Interface Matrix
Neural Mimicry ships four complementary surfaces: the browser control surface, this documentation shell, Swagger for executable API requests, and the native egui dashboard. The matrix below defines how those surfaces divide responsibility without drifting in language, branding, or runtime behavior.
Design rule: every browser surface shares one auth/session shell and one runtime vocabulary.
Web UI is operational, Docs is explanatory, Swagger is executable, and Native UI remains the deepest local surface.
Runtime Session
Auth Mode
Loading...
Session
Checking...
Default Orchestrator
Loading...
Function Matrix
| Function | Web UI | Docs | Swagger | Native UI |
|---|---|---|---|---|
| Session and auth flow | Operational | Operational | Operational | Companion |
| Runtime target and cluster status | Operational | Context | Context | Operational |
| Network control lifecycle | Operational | Reference | Try It Out | Operational |
| Topology visualization | Operational | Reference | Reference | Operational |
| Probes, EQ, scope, raster | Operational | Reference | Reference | Operational |
| Architecture and bio tuning | Contextual | Reference | Request Tests | Operational |
| Save, load, import, export | Operational | Reference | API Tests | Operational |
| Schema and endpoint discovery | Companion | Operational | Operational | Companion |
Auth Flow
1. Call
GET /api/auth/mode or use the session shell above to discover whether the server is running in none, local, or oidc mode.2. In
local mode, log in with POST /api/login. In oidc mode, begin browser login with GET /auth/oidc/login.3. Protected API requests then use the same-origin
nm_session cookie, which Swagger sends automatically.curl -s http://localhost:8080/api/auth/mode
curl -s -X POST http://localhost:8080/api/login \
-H 'content-type: application/json' \
-d '{"username":"admin","password":"change-me"}' -i
curl -s http://localhost:8080/api/status --cookie "nm_session=<value>"Endpoint Matrix
| Method | Path | Auth | Purpose |
|---|---|---|---|
| GET | /api/openapi.json | No | Machine-readable OpenAPI schema. |
| GET | /api/config | No | Bootstrap default orchestrator config. |
| GET | /api/auth/mode | No | Auth mode and local signup capability. |
| GET | /api/me | No | Current session/user identity. |
| POST | /api/login | No | Local username/password login. |
| POST | /api/signup | No | Create a local account when enabled. |
| POST | /api/logout | Cookie | Clear the active session. |
| GET | /api/user/config | Cookie | Read per-user persisted browser UI state. |
| POST | /api/user/config | Cookie | Persist browser UI state. |
| GET | /api/status | Cookie | Cluster and network status snapshot. |
| GET | /api/snapshot | Cookie | Full network snapshot JSON. |
| GET | /api/activity | Cookie | Latest spike activity vectors. |
| POST | /api/update_network | Cookie | Apply config JSON or full snapshot JSON to a managed network. |
| POST | /api/control_network | Cookie | Start, stop, repeat, reset, or create a new network. |
| POST | /api/aer/inject | Cookie | Inject a single AER exchange or spike index frame. |
| POST | /api/aer/stream | Cookie | Stream NDJSON AER frames over HTTP. |
| GET | /api/export | Cookie | Export the active network to NeuroML, PyNN, NIR, ONNX, or TFLite. |
| GET | /auth/oidc/login | No | Start OIDC browser login. |
| GET | /auth/oidc/callback | No | OIDC callback route. |
| POST | /auth/oidc/exchange | No | Token-to-session exchange. |
Companion Surfaces
Web UI: remote target selection, cluster status, topology rendering, probes, browser save/load, and export.
Swagger: direct request execution using the same session cookie as the browser shell.
Native UI: richest local simulation surface for morphology, deep biology, GA search, and local import/export workflows.