Operator manual

Operator Bridge API

Use the shipped ingest API for companion camera and voice inputs.

Purpose

The Bridge API is the versioned ingest surface for companion devices - camera frames and voice audio from the Pi Tablet Bridge or your own hardware. It ships today so companions can integrate without waiting for an appliance update.

Authentication

Every call authenticates with a personal access token (created under the account menu) sent as a Bearer header. Treat one token per device.

Endpoints

  • POST /api/bridge/v1/frame - multipart JPEG; the vision pipeline describes it and the description enters company memory.
  • GET /api/bridge/v1/tts - synthesize speech for the companion to play.
  • POST /api/bridge/v1/audio - reserved for voice input; reports itself honestly when speech-to-text is not configured.
  • GET /api/bridge/v1/health - capability report for the companion.

Limits

Frames are capped at 8 MB and read no further than the cap, so an oversized upload is refused without buffering into appliance memory.