API Reference
Complete reference for all 57 JSON-RPC methods. Click any method to see request and response examples.
Authentication
The AudioMap API requires session token authentication. The API is available on the Pro license tier. Every WebSocket connection must authenticate before calling any other method.
How it works
- 1When AudioMap launches, it generates a random session token (UUID) and writes it to a file on disk.
- 2Your client reads the token from the file and sends it as the first message after connecting.
- 3Once authenticated, all API methods are available for the lifetime of the connection.
- 4The token is deleted when AudioMap shuts down. A new token is generated on next launch.
Token file location
~/Library/Application Support/AudioMap/api_session_token%APPDATA%\AudioMap\api_session_tokenExample
{
"jsonrpc": "2.0",
"method": "authenticate",
"params": {
"token": "a1b2c3d4e5f6..."
},
"id": 1
}{
"jsonrpc": "2.0",
"result": {
"authenticated": true
},
"id": 1
}Security note: The token file is only readable by the local user, so other devices on the network cannot access the API without physical access to the machine running AudioMap. All API calls sent before authentication will receive a -32000 error.
Authentication
1 methodsState & Configuration
9 methodsGenerators
2 methodsCapture
3 methodsMeasurements
4 methodsReflections & Surfaces
3 methodsTuning
6 methodsAudio Devices
2 methodsCalibration
2 methodsProject
5 methodsPlayback Control
4 methodsLive Data
3 methodsTiming & Alignment
3 methodsHeatmap & Spatial
2 methodsRouting & Configuration
4 methodsEvents
2 methodsEvent Notifications
Events are server-initiated messages pushed to subscribed clients. They have no id field. Events are filtered per-client — each connection only receives events it has subscribed to. Invalid event names passed to subscribe are reported back as errors.
{
"jsonrpc": "2.0",
"method": "event.measurementAdded",
"params": {"id": "uuid-1", "name": "S0R0: 5.2ms"}
}| Event | Description |
|---|---|
| measurementAdded | New measurement captured |
| measurementRemoved | Measurement deleted |
| captureComplete | Spatial auto-capture finished (includes measurements) |
| captureStateChanged | Capture progress update |
| surfaceInferenceComplete | Surface detection finished |
| audioDeviceChanged | Audio device configuration changed |
| stateChanged | Any configuration change |
| delayMeasured | Delay measurement completed — includes sourceIndex, receiverIndex, delaySamples, delayMs |
| projectLoaded | Project file loaded — includes path and name |
| projectSaved | Project file saved — includes path |
| fftSizeChanged | FFT size changed — includes oldSize and newSize |