Playlists API

Create playlists, add scenes, reorder, publish.

Updated May 18, 2026·4 min read

Create a playlist

Shell
curl -X POST https://api.menupi.com/v1/playlists \
  -H "Authorization: Bearer mpi_live_••••••" \
  -d '{ "name": "Counter Boards" }'

Add a scene

Shell
curl -X POST https://api.menupi.com/v1/playlists/pl_8XR4.../scenes \
  -H "Authorization: Bearer mpi_live_••••••" \
  -d '{ "sceneId": "sc_K9V3...", "durationSeconds": 12, "schedule": { "type": "daypart", "start": "06:00", "end": "10:30" } }'

Reorder scenes

Shell
curl -X PATCH https://api.menupi.com/v1/playlists/pl_8XR4.../order \
  -H "Authorization: Bearer mpi_live_••••••" \
  -d '{ "order": ["sc_K9V3...", "sc_L2M5...", "sc_P7Q1..."] }'

Publish

Publishing increments the playlist version. Connected players pick up the new version at their next loop boundary.

HTTP
POST https://api.menupi.com/v1/playlists/{id}/publish

Endpoint summary

MethodPathSummary
POST/playlistsCreate an empty playlist.
GET/playlists/{id}Retrieve playlist with ordered scene list.
POST/playlists/{id}/scenesAppend a scene to the playlist.
PATCH/playlists/{id}/orderReorder scenes.
POST/playlists/{id}/publishIncrement version + roll to connected players.