TabGeckoDocs
Website
Documentation / Live synchronizer

Live synchronizer

Broadcast selected input from one running source profile to explicitly selected followers. This is live browser control, not profile storage synchronization.

Start with explicit targets

POST /api/v1/automation/synchronizer/start
{
  "source_id": "SOURCE_PROFILE_ID",
  "follower_ids": [
    "FOLLOWER_PROFILE_ID"
  ],
  "mode": "element",
  "options": {
    "mouse": true,
    "keyboard": true,
    "scroll": true,
    "navigation": false,
    "tabs": false
  }
}

Changing the synchronizer requires runtime:control and sync:control; reading its status requires runtime:control. Read GET /api/v1/automation/synchronizer before and after starting. The source and followers must be suitable running profiles; the API schema permits 1–20 unique follower IDs. element mode resolves page elements; coordinates mode uses positions and depends on compatible window geometry. Neither mode guarantees that different websites or layouts receive equivalent actions.

Options, text and tabs

PATCH /options changes mouse, keyboard, scroll, navigation, tabs, native_controls, extension_pages and delay bounds. Select native_controls and extension_pages before starting. Changing either while synchronization is running returns 409; stop, change the options, then start again with the intended targets. Delay bounds are 0–5000 ms. POST /text uses the selected target_id and optional selector/frame chain with same, lines, shuffle or random mode; inspect its exact schema before broadcasting. POST /tabs supports open, align, activate, reload, close, close_others and close_blank. Closing tabs and sending text are side effects on every selected follower.

All shorthand routes in this section are relative to /api/v1/automation/synchronizer. Read the returned per-target outcomes and current status; unsupported input is not a successful synchronization.

Stop and verify

HTTP
POST /api/v1/automation/synchronizer/stop
GET /api/v1/automation/synchronizer

Stop synchronization before changing the selected source/followers. Stopping the synchronizer does not reverse navigation, text input or other actions that already reached a follower. A lost source or follower connection stops synchronization and records an error in its status. Check that all intended profiles are running, then explicitly start a new session. The synchronizer does not automatically restart a closed profile. Browser/engine-specific limitations still apply in both modes.