Skip to content

Add REST API for remote playback control#5797

Open
Gonzoe79 wants to merge 1 commit into
yuliskov:masterfrom
Gonzoe79:master
Open

Add REST API for remote playback control#5797
Gonzoe79 wants to merge 1 commit into
yuliskov:masterfrom
Gonzoe79:master

Conversation

@Gonzoe79

Copy link
Copy Markdown

Summary

Adds an opt-in REST API that allows external clients to control playback, manage the queue, and browse recommendations remotely.

Endpoints

  • POST /api/v1/playback/play|pause|toggle|next|previous|stop|pip
  • POST /api/v1/playback/seek?positionMs={ms}
  • GET /api/v1/playbackstate
  • GET /api/v1/queue
  • POST /api/v1/queue/items?videoUrl={url}&shuffle={bool}
  • GET /api/v1/recommendations

Security

  • REST API Disabled by default
  • Basic HTTP authentication (configurable username/password)
  • Configurable port (default: 8090)

API Documentation

See openapi.yaml in the ./docs.

Notes

  • Adds gson dependency for JSON serialization

Adds a local-network REST API (NanoHTTPD) to control playback, manage
the queue, and play YouTube playlists. Includes OpenAPI docs, settings
UI, basic auth, and unit tests.
@Gonzoe79

Copy link
Copy Markdown
Author

Hi @yuliskov ,
i removed some noise from the commit and pulled the latest changes.
happy to hear your feedback

best regards

@yuliskov

Copy link
Copy Markdown
Owner

Got it. Thanks

@akshaynexus

akshaynexus commented Jun 12, 2026

Copy link
Copy Markdown

ah damn didnt see this before i ended up making my own rest api adition to smart tube

Ill probably clean up my branch and open a pr,i have a few extra changes and features i added for better control/discovery

@visualglitch91

Copy link
Copy Markdown

@akshaynexus @Gonzoe79 i was literally about to implement this as well since the lounge api is not very reliable, only thing missing here for me is a "play next" endpoint since the queue on puts the item at the end of the queue

@akshaynexus

Copy link
Copy Markdown

@akshaynexus @Gonzoe79 i was literally about to implement this as well since the lounge api is not very reliable, only thing missing here for me is a "play next" endpoint since the queue on puts the item at the end of the queue

Do check the pr I opened and see if that fits most of your requirements ,if not do comment and I'll add it to the pr

@Gonzoe79

Gonzoe79 commented Jun 24, 2026

Copy link
Copy Markdown
Author

@yuliskov
where you already able to have a look at the PR?

theres another PR from @akshaynexus (#5896) that go in the same direction. maybe we should unify things... but i think we would need some feedback from you.

@yuliskov

Copy link
Copy Markdown
Owner

I can't estimate a date yet. I'm working on higher-priority tasks right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants