Local API examples
Ready-made open-source apps built on the Local API: App Kit, Travel Globe, Roulette and Avatar. Run them as they are, or start your own from them.
Ready-made apps built on the Local API. Each one is open source on GitHub: run it as it is, or use it as the starting point for your own.
Chapters (12)
- 0:00What you can build
- 0:13Turn it on: Settings › Advanced › Local API
- 0:26The password: Bearer token or X-QBooth-Key
- 0:35The built-in Sandbox
- 0:41Greyed-out commands and "available"
- 0:53202 accepted, then poll status
- 1:05Errors: 409 wrong_page
- 1:14A whole guest in four calls
- 1:28Nothing is bypassed
- 1:41Docs page and the API log
- 1:51No code? The Remote Control
- 1:58Wrap-up
The apps run on Windows 10/11 with Node.js 22, next to Q-Booth with the Local API turned on. Each repository's README says how to install, set up and build it. They are examples, shared as they are.
App Kit
Start here to build your own app. The kit does the plumbing: the connection to the booth, the template covers, a window that shows only on the pages you choose, operator settings with a PIN, a layout for any screen, a fake booth for testing without Q-Booth, and a tool that builds the app's exe. It includes a simple example app that shows the event's templates as cards, where a tap starts the session. The guides are in English, Bahasa Indonesia and 中文.
Travel Globe
A globe on the Welcome screen that guests spin with a finger. Every template named after a place gets a pin. A tap flies there and shows the template's cover on a postcard, and Let's go! starts the session with that template. Surprise me! lands on a random destination. The repository also has a ready-made event with 15 destinations to import.
github.com/lumaqube/App-Travel
Roulette
A theme wheel made of the running event's templates, with their covers. A guest spins it, the winner is picked in Q-Booth, and the photo session starts with it. It comes with music and sound effects, and texts in English, Bahasa Indonesia and 中文.
github.com/lumaqube/App-Roulette
Avatar
A 3D character in a corner of the event screen. It greets guests, talks with them by voice, guides them through the booth's screens, and presses the buttons for them when asked: start, pick a template, take the photo, retake, process, print and QR. The speech and the AI run on the PC, with an optional cloud AI.
Still need help?
Our team answers on WhatsApp. Tell us your Q-Booth version and what you see on screen.