Interface Matrix
NeuralMimicry 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 behaviour.
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 visualisation | 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 |
Authorisation 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, sign in with POST /api/login. In oidc mode, begin browser login with GET /auth/oidc/login.3. Protected browser requests then use the same-origin
nm_session cookie, which Swagger sends automatically, and must also satisfy the resolved service_access.aarnn grant.4. Backend integrations may instead present a Customers-issued bearer token.
POST /api/llm/mirror is designed for that service-account path.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>"Service Access Tiers
request: service discovery, token views, and user configuration.observe: runtime status, workspace detail, snapshots, activity, and export.use: create/import workspaces and run non-destructive workspace actions such as start, repeat, save, and step.control: destructive or supervisory actions such as workspace deletion, stop, reset, and new.Endpoint Matrix
| Method | Path | Access | 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 sign-up capability. |
| GET | /api/me | No | Current session/user identity. |
| POST | /api/login | No | Local username/password sign-in. |
| POST | /api/signup | No | Create a local account when enabled. |
| POST | /api/logout | Session | Clear the active session. |
| GET | /api/tokens | AARNN request | Read token balance and linked commercial URLs. |
| GET | /api/tokens/ledger | AARNN request | Read token ledger history. |
| GET | /api/user/config | AARNN request | Read per-user persisted browser UI state. |
| POST | /api/user/config | AARNN request | Persist browser UI state. |
| GET | /api/runtime/status | AARNN observe | Read workspace runtime status and autoscaler context. |
| GET | /api/runtime/workspaces | AARNN observe | List the caller's workspaces. |
| POST | /api/runtime/workspaces | AARNN use | Create a new workspace. |
| GET | /api/runtime/workspaces/{workspace_id} | AARNN observe | Read a workspace summary and runtime detail. |
| DELETE | /api/runtime/workspaces/{workspace_id} | AARNN control | Delete a workspace. |
| GET | /api/runtime/workspaces/{workspace_id}/snapshot | AARNN observe | Read the latest saved workspace snapshot. |
| GET | /api/runtime/workspaces/{workspace_id}/activity | AARNN observe | Read live workspace activity vectors. |
| POST | /api/runtime/workspaces/{workspace_id}/control | AARNN use or control | Run workspace lifecycle actions. Destructive actions require control. |
| POST | /api/runtime/workspaces/{workspace_id}/import | AARNN use | Import config or snapshot payloads into a workspace. |
| GET | /api/runtime/workspaces/{workspace_id}/export | AARNN observe | Export the active workspace to NeuroML, PyNN, NIR, ONNX, or TFLite. |
| GET | /api/status | Disabled for authenticated sessions | Cluster and network status snapshot. |
| GET | /api/snapshot | Disabled for authenticated sessions | Full network snapshot JSON. |
| GET | /api/activity | Disabled for authenticated sessions | Latest spike activity vectors. |
| POST | /api/update_network | Disabled for authenticated sessions | Apply config JSON or full snapshot JSON to a managed network. |
| POST | /api/control_network | Disabled for authenticated sessions | Start, stop, repeat, reset, or create a new network. |
| POST | /api/aer/inject | Disabled for authenticated sessions | Inject a single AER exchange or spike index frame. |
| POST | /api/aer/stream | Disabled for authenticated sessions | Stream NDJSON AER frames over HTTP. |
| POST | /api/llm/mirror | AARNN use | Mirror Gail exchanges into persisted AER stimuli and return an optional bootstrap candidate reply. |
| GET | /api/export | Disabled for authenticated sessions | 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.