127.0.0.1 only — it is never reachable from the network. When enabled, it writes a discovery file containing the port and a bearer token so MCP wrappers, benchmark scripts, and Shortcuts can locate it without you copying credentials anywhere.
The server is off by default. You turn it on once in Settings and it stays on across restarts.
Enabling the server
- macOS
- Windows
- Open Settings → API Server.
- Flip the toggle to on. The status line updates to show the bound address and the last four characters of your bearer token.
Connection tab
The Connection tab shows the live values you need to talk to the server.| Field | What it shows |
|---|---|
| Port | The port the server is listening on. A Copy button puts it on the clipboard. |
| Bearer token | Hidden by default. Use Reveal to see the full value, Copy to copy it, or the regenerate button to rotate it (see below). |
| Port file | Full path to the discovery file on disk. A Show button opens the file in Finder (macOS) or Explorer (Windows). |
Bearer token
Every request exceptGET /health must include the bearer token:
%LOCALAPPDATA%\HyperWhisper\local-api-token.bin on Windows). It persists across restarts so you do not need to update your scripts each time.
To rotate the token, click the regenerate button (the circular arrows icon on macOS, the rotate button on Windows). The previous token stops working immediately. Any MCP clients or scripts that cached the old token must be updated — they can read the new value from the discovery file.
MCP setup tab
The MCP setup tab shows the configuration snippet to paste into your MCP client. The bridge reads the discovery file at startup so no port or token appears in the client config.cURL tab
The cURL tab shows pre-filled shell commands using your live port and token.- macOS
- Windows
When the server is running the snippet embeds your live values directly:If the server is not yet running the snippet falls back to reading from the discovery file:
Discovery file
When the server starts it writes a JSON file that MCP wrappers and scripts read to learn the port and token without you hard-coding them anywhere.- macOS
- Windows
chmod 600 — readable only by your user account.If you see Connection refused and the discovery file exists, the port it records is stale. Toggle the Local API switch off and back on to write a fresh file.
Available endpoints
| Method | Path | Auth | Purpose |
|---|---|---|---|
| GET | /health | None | Server identity and status. |
| GET | /models | Required | Model catalog. |
| GET | /modes | Required | List saved Modes. |
| POST | /modes | Required | Create a Mode. |
| GET | /modes/{id} | Required | Fetch one Mode. |
| PATCH | /modes/{id} | Required | Partial-field update. |
| DELETE | /modes/{id} | Required | Delete a Mode. |
| POST | /transcribe | Required | Transcribe an audio file. |
| POST | /post-process | Required | Rewrite text via preset or custom prompt. |
| GET | /recordings/search | Required | Substring search across past transcripts. |
| GET | /recordings/{id} | Required | Single transcript row. |
Next steps
- MCP setup guide — wire HyperWhisper into Cursor, Claude Desktop, or Claude Code as an agent tool.
- API overview — authentication, response envelope, and error codes.
