Skip to content
Overview
Overlay developer
Overview

Overview

Overlays and companion apps talk to Bridge over the local HTTP and WebSocket API (default 127.0.0.1:29067). Bridge is the hub; your overlay stays a thin client. CORS allows browser sources hosted elsewhere to call that local API.

Ready-made OBS overlays (Overview, Compact, Bar, and others) are served by Bridge on your PC — copy URLs from Printers → Details. User setup: Overlays in OBS. This section is for building your own clients or understanding the API those widgets use.

Typical uses

  • Live print progress, temperatures, and job name on stream
  • Elapsed / remaining / estimated total time from job.* fields
  • Status badges that react to print started / finished / failed
  • Thumbnails or camera snapshot URLs when a printer plugin exposes them

Where to start

  1. Run Bridge and add at least one printer (see User docs). Copy the printer id from Printers → Details.
  2. Either use a built-in overlay (http://127.0.0.1:29067/bridge/overview/?printer=… or /bridge/bar/?printer=…), drop your own HTML into Bridge’s custom folder, or call the HTTP & WebSocket API from a page you host elsewhere.
  3. Prefer the event WebSocket (/v1/events) for live updates; use REST for one-shot reads. You do not need a special Kinkajou JS SDK — browser fetch / WebSocket (or any HTTP client you already use) is enough. Built-in and custom overlays served by Bridge can also load /bridge/_shared/bridge-client.js.

Streamer.bot is a separate, optional path: Bridge can push DoAction into Streamer.bot for automation. Overlays do not require Streamer.bot — they should use the Bridge API directly unless you intentionally route everything through Streamer.bot.

API