SuperViz

SuperViz provides real-time collaboration and data-synchronization infrastructure for web applications - presence, realtime data channels, video huddle/meetings, contextual comments, and mouse pointers. The product is SDK-first (@superviz/sdk and @superviz/react-sdk initialized with a developer key), supported by a REST API at api.superviz.com for participants, presence, channels, rooms, comments, and meetings, an event-driven realtime channel API, and webhooks.

8 APIs 0 Features

Real TimeCollaborationPresenceSynchronizationVideoWebRTCSDK

APIs

SuperViz Participants API

Server-side REST endpoint that returns the list of participants currently connected to a given realtime channel, authenticated with the client_id and secret developer keys.

SuperViz Channels API

Lists the realtime channels active for a room, used to introspect where presence and messages are flowing across a collaborative application.

SuperViz Realtime Data API

Publish (post) events with an arbitrary JSON payload to a named realtime channel from a backend, so servers can push synchronized data to connected SDK clients. The channel/even...

SuperViz Rooms API

Collaboration REST surface for rooms - retrieve a room's participants and related collaboration context, with cursor-style pagination on list responses.

SuperViz Contextual Comments API

Reads the contextual comments (annotations pinned to elements of a web app or 3D scene) created through the Collaboration SDK, exposed server-side over REST for backend workflows.

SuperViz Meetings API

Retrieves video meeting (huddle) statistics - duration, minutes, price, recordings, and per-participant join detail - for meetings created with the Video SDK.

SuperViz Webhooks API

Outbound webhook notifications SuperViz POSTs to a preconfigured receiver when events occur - meeting stats available (MEETING_STATS), recording ready, and transcription ready. ...

SuperViz Authentication API

Credential model for SuperViz - a developer key initializes the client SDK, while a Client ID plus Secret Key pair (from Dashboard > Developer > Keys) authenticates all server-s...

Collections

SuperViz REST API

OPEN

Pricing Plans

Superviz Plans Pricing

3 plans

PLANS

Rate Limits

Superviz Rate Limits

4 limits

RATE LIMITS

FinOps

Superviz Finops

FINOPS

Event Specifications

SuperViz Realtime Channels & Webhooks

AsyncAPI 2.6 description of SuperViz's genuinely event/channel-based surfaces: 1. **Realtime channels** - SuperViz is a real-time synchronization platform. Clients using `@super...

ASYNCAPI

Resources

Sources

opencollection: 1.0.0
info:
  name: SuperViz REST API
  version: '1.0'
request:
  auth:
    type: apikey
    apikey:
    - key: client_id
      value: '{{client_id}}'
      in: header
    - key: secret
      value: '{{secret}}'
      in: header
items:
- info:
    name: Presence
    type: folder
  items:
  - info:
      name: Get participants connected to a channel
      type: http
    http:
      method: GET
      url: https://api.superviz.com/realtime/1.0/participants/:channel
      params:
      - name: channel
        value: my-channel
        type: path
        description: The name of the realtime channel to query.
    docs: Returns the list of participants currently connected to the named realtime channel.
- info:
    name: Channels
    type: folder
  items:
  - info:
      name: List realtime channels
      type: http
    http:
      method: GET
      url: https://api.superviz.com/realtime/1.0/channels
    docs: Lists the realtime channels active for the authenticated account or room.
- info:
    name: Realtime
    type: folder
  items:
  - info:
      name: Publish an event to a channel
      type: http
    http:
      method: POST
      url: https://api.superviz.com/realtime/1.0/channels/:channel/events
      params:
      - name: channel
        value: my-channel
        type: path
        description: The name of the realtime channel to publish to.
      body:
        type: json
        data: "{\n  \"name\": \"price-update\",\n  \"data\": {\n    \"symbol\": \"ACME\",\n    \"price\": 42.5\n  }\n}"
    docs: Publishes an event with an arbitrary JSON payload to the named realtime channel; subscribed SDK clients receive
      it in real time.
- info:
    name: Rooms
    type: folder
  items:
  - info:
      name: Get participants in a collaboration room
      type: http
    http:
      method: GET
      url: https://api.superviz.com/rooms/:roomId/participants
      params:
      - name: roomId
        value: room-abc
        type: path
        description: The identifier of the collaboration room.
      - name: limit
        value: '50'
        type: query
        description: Maximum number of participants to return per page.
      - name: startAfter
        value: ''
        type: query
        description: Pagination cursor - return participants after this participant id.
    docs: Returns the participants associated with a collaboration room, with cursor-style pagination.
- info:
    name: Comments
    type: folder
  items:
  - info:
      name: List contextual comments for a room
      type: http
    http:
      method: GET
      url: https://api.superviz.com/rooms/:roomId/comments
      params:
      - name: roomId
        value: room-abc
        type: path
        description: The identifier of the collaboration room.
      - name: limit
        value: '50'
        type: query
        description: Maximum number of comments to return per page.
    docs: Returns the contextual comments (annotations) created through the Collaboration SDK for the given room.
- info:
    name: Meetings
    type: folder
  items:
  - info:
      name: Get video meeting statistics
      type: http
    http:
      method: GET
      url: https://api.superviz.com/meetings/:meetingId
      params:
      - name: meetingId
        value: meeting-01hxyz
        type: path
        description: The identifier of the meeting.
    docs: Retrieves statistics for a video huddle / meeting created with the Video SDK.