How it works

Your page imports the hosted loader and calls loadWeei(). Weei loads the current release, applies your site's settings and returns a client. Participants on the same page connect to each other; widgets such as chat, notes or your own share data between them.

Which built-in widgets a site may use is configured for your account. Widgets you add with addWidget() are always available on your site.

Versions

This documentation describes API version 1. The loader always selects the current release for your site; you can pin a release with loadWeei({ releaseId }).

Contents

Start

  • Get Started — Load Weei on a page, wait for it to initialize, show the panel and verify the integration.

API reference

  • Client API — loadWeei() and the Weei client: readiness, panel visibility, user identity, widgets and site widgets.
  • Peers, rooms and media — Use Weei without its UI: list participants, connect to peers, move between rooms, turn on the camera and render the streams yourself.

Built-in widgets

  • Overview — The widgets built into Weei, what they are for, and how to open them and call their APIs with widgetsApi.
  • Chat — Chat: Messages, files, voice and video messages between participants.
  • Whiteboard — Whiteboard: A shared drawing surface over your page.
  • Notes — Notes: Meeting notes grouped by day and meeting.
  • Voting — Voting: Polls with live results.
  • Planning poker — Planning poker: Estimate tasks with Fibonacci or T-shirt cards.
  • Retrospective board — Retrospective board: Retrospectives in writing, voting and discussion phases.
  • Approval and decision cards — Approval and decision cards: Collect approvals and decisions from participants.
  • Reactions — Reactions: Emoji reactions that float over the page for everyone.
  • Raise hand — Raise hand: A queue of raised hands.
  • Recording Demos — Recording Demos: Record and replay demos, capture issues, report your app's events.
  • Distributed Neural Training — Distributed Neural Training: Train a neural network together in participants' browsers.
  • Transcription — Transcription: Live speech-to-text in the browser.
  • Shared document preview — Shared document preview: Review a PDF, image or text file together.
  • AI assistant — AI assistant: An AI chat inside your page.
  • Parallel computing — Parallel computing: A demonstration of splitting a computation between participants.
  • Connection diagnostics — Connection diagnostics: Ping, clock offset, network map and connection logs.

Site widgets

  • Build a site widget — Step-by-step tutorial: a counter shared by everyone in the session, with a window, peer messages and notifications.
  • Site widget reference — The site widget and connector contracts, the app object, weei.sdk and the rules for site widgets.

Connectors

Help

  • Troubleshooting — Loader errors, network checks and common integration problems.

For use cases rather than API details, see Solutions.