Rest api?

[JarbasAl]

Hello

I am really enjoying music assistant, I am interested in integrating it with my own code since I am not a home assistant user.

I found https://github.com/music-assistant/client but nothing in the documentation about it, is there some reference for the server api that i could use? I am looking for something like a REST or websocket api

Thanks

[OzGav]

We don’t publish full details about the api. What are you wanting to do?

[JarbasAl]

well, I'm trying to see what is possible to do...

For context I am the lead developer of OpenVoiceOS and started investigating due to a user request

For an integration there a few main goals i have:

• searching MA for playable media based on a user query, if possible the goal is to get a direct stream (a playable url OVOS can handle)
• searching MA for available players, casting playback to one of them (with a playable url sent from OVOS)

Besides functionality related to playback i'd be also interested in general stats, allow user queries from OVOS side of the sort "how many albums do i have in my library" and the likes

I would be happy to either follow a contract defined by music-assistant and consume an api, or to somehow write a plugin to allow MA to speak to some other api contract i define in OVOS side

[OzGav]

If you can, come to the dev channel on Discord for more timely answers to your questions https://discord.com/channels/753947050995089438/1260489193763639338

[JarbasAl]

I would rather not join any discord if possible 😅

I don't mind slower answers, I actually prefer if they are well thought out even if they are huge instead of "quick fire" style in chats.

That also allows me to read them more carefully and to revisit when needed, getting lost in a chat doesnt help with general "hivemind" knowledge and isnt searchable for the next user

[marcelveldt]

MA uses a websockets API which is also partially exposed as json/rest API.

Look at the client library for reference: https://github.com/music-assistant/client
or if you prefer javascript/typescript, see the frontend code: https://github.com/music-assistant/frontend/blob/main/src/plugins/api/index.ts

It's super straight forward so you should be able to figure it out quickly enough.
Unfortunately we do not have the capacity to write docs for the API now and we prefer if people use the official python client.

[JarbasAl]

Is there any documentation for the client library or usage examples? or do I need to just dig trough the source code?

I'm still trying to gauge what is feasible or not, I assume the use cases i described above are possible via the api?

If it's just a matter of documentation I totally get it and can probably set aside some time to just read the source code and figure it out, but I'd rather not spend that time if you tell me right away my usecase is not covered

[OzGav]

Sorry no documentation

[Hedda]

I am really enjoying music assistant, I am interested in integrating it with my own code since I am not a home assistant user.

I found https://github.com/music-assistant/client but nothing in the documentation about it, is there some reference for the server api that i could use? I am looking for something like a REST or websocket api

Is there any documentation for the client library or usage examples? or do I need to just dig trough the source code?

@JarbasAl even if you are not using Home Assistant yourself it might still be a good idea to look at its integration code for Music Assistant?

That it, suggest you also look at the music_assistant integration component in home-assistant's core (backend):

• https://github.com/home-assistant/core/tree/dev/homeassistant/components/music_assistant

The music_assistant integration component in the core backend is using that Python client to interact with the Music Assistant Server API.

Maybe also look into how it is integrated into home-assistant's frontend as well (though think it's deeply embedded with the backend core?)?

• https://github.com/home-assistant/frontend

[Hedda]

MA uses a websockets API which is also partially exposed as json/rest API.

Look at the client library for reference: https://github.com/music-assistant/client or if you prefer javascript/typescript, see the frontend code: https://github.com/music-assistant/frontend/blob/main/src/plugins/api/index.ts

It's super straight forward so you should be able to figure it out quickly enough. Unfortunately we do not have the capacity to write docs for the API now and we prefer if people use the official python client.

@JarbasAl might it also be a good idea to partially study documentation for the general/generic Home Assistant WebSocket API integration as indirect reference since there at least looks to be plenty of documentation for that and can maybe assume that Music Assistant's approach is similar, or?

• https://developers.home-assistant.io/docs/api/websocket/

• https://www.home-assistant.io/integrations/websocket_api/

• https://github.com/home-assistant/home-assistant-js-websocket

• https://quickstarts.postman.com/guide/home-assistant/index.html?index=..%2F..index#0

  • https://www.youtube.com/watch?v=Qk9A0QbG5-I

[JarbasAl]

it will be a while before i get to this, it needs way too much research before i can even get started and i simply can not allocate the needed time for now.

i'm really digging MA as a user, but the time i've already wasted researching docs and perusing source code without clear answers demotivated me for the time being

[OzGav]

There is now API documentation for the 2.7.0 beta and later versions of Music Assistant. The API documentation is automatically generated and available at http://your_ma_server_ip:8095/api-docs

[RJrodrigo]

Is there way to remove tracks from playlist by uri instead?

    async def remove_playlist_tracks(
        self, db_playlist_id: str | int, positions_to_remove: tuple[int, ...]
    ) -> None:
        """Remove multiple tracks from playlist."""
        await self.client.send_command(
            "music/playlists/remove_playlist_tracks",
            db_playlist_id=db_playlist_id,
            positions_to_remove=positions_to_remove,  💢
        )

like in add track to playlist

       async def add_playlist_tracks(self, db_playlist_id: str | int, uris: list[str]) -> None:
        """Add multiple tracks to playlist. Creates background tasks to process the action."""
        await self.client.send_command(
            "music/playlists/add_playlist_tracks",
            db_playlist_id=db_playlist_id, 
            uris=uris,  ✨
        )

or alternatively some way inside home assistant to get the position of the track that is currently in a playlist?

i am having trouble using this call to get all tracks in playlist so that i can compare and get the position...

 async def get_playlist_tracks(
        self,
        item_id: str,
        provider_instance_id_or_domain: str,
        page: int = 0,
    ) -> list[Track]:
        """Get tracks for given playlist."""
        return [
            Track.from_dict(obj)
            for obj in await self.client.send_command(
                "music/playlists/playlist_tracks",
                item_id=item_id,
                provider_instance_id_or_domain=provider_instance_id_or_domain,
                page=page,
            )
        ]

can't decipher what the parameters are?
item_id same as db_playlist_id?
provider_instance_id_or_domain what do i put here?
page need to get all to find position....

[OzGav]

In the beta version of the server there is info about the API https://beta.music-assistant.io/api/