Muro Box Officially Supports Open API!
(Refer to the complete manual here.)
With API key authentication, third‑party services and automation tools—such as Home Assistant, IFTTT, or your own custom scripts—can directly control your music box: play songs and playlists, stop playback, adjust device settings, and search the song and playlist catalog.
All playback happens on the music box itself. The API does not return MIDI files or download links, ensuring copyright protection and integrity of the music content.
What You Can Do with the API
- Play a single song (
play_song) - Play a playlist; the system automatically filters playable songs based on account permissions (
play_playlist) - Stop current playback (
stop_playing) - Read and update device settings: motor speed, shuffle mode, maximum playback time, MIDI output, Bluetooth MIDI toggle (
device_settings) - Search songs and playlists with keyword, pagination, and multilingual name support (
search/songs,search/packages)
Getting Started in 3 Steps
- Open the Muro Box App → Settings → API Keys → Add. Name the key and confirm. The full key will only be shown once—copy and save it immediately (it cannot be retrieved later).
- Find your device serial number (
device_sn) in the App’s device settings page. - Call the API: send a POST request to
https://api.murobox.com/muro_api/v1/...with your API key in the header.
curl -X POST https://api.murobox.com/muro_api/v1/devices/play_song/ \
-H "api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"device_sn": "YOUR_DEVICE_SN", "song_id": "SONG_ID"}'
Song IDs (song_id) and playlist IDs (playlist_id) can be copied directly in the App: “Copy Song ID” in the player menu, or “Copy Playlist ID” in the playlist details page.
Security and Usage Notes
- API keys are equivalent to passwords. The server only stores SHA‑256 fingerprints; the original key cannot be recovered. Do not share it.
- Each key allows up to 60 requests per minute (exceeding this returns HTTP 429).
- Keys can only control music boxes bound to the same account; they cannot be used to download songs or MIDI files.
- For complete endpoint documentation and a ready‑to‑import Postman Collection, please refer to the Muro Box Open API User Guide.
