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.
APIs.json: https://raw.githubusercontent.com/api-evangelist/superviz/refs/heads/main/apis.yml
- Real Time
- Collaboration
- Presence
- Synchronization
- Video
- WebRTC
- SDK
- Created: 2026-07-01
- Modified: 2026-07-01
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.
- Human URL: https://docs.superviz.com/realtime/1.0/rest-api/presence
- Base URL:
https://api.superviz.com
- Participants
- Presence
- Real Time
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Lists the realtime channels active for a room, used to introspect where presence and messages are flowing across a collaborative application.
- Human URL: https://docs.superviz.com/realtime/1.0/rest-api/channels
- Base URL:
https://api.superviz.com
- Channels
- Real Time
- Presence
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
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/event model is described as AsyncAPI alongside the REST publish endpoint.
- Human URL: https://docs.superviz.com/realtime/1.0/rest-api/publish-message-to-channel
- Base URL:
https://api.superviz.com
- Real Time
- Events
- Pub Sub
- Synchronization
- Documentation
- OpenAPI — OpenAPI Specification
- AsyncAPI — AsyncAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Collaboration REST surface for rooms - retrieve a room's participants and related collaboration context, with cursor-style pagination on list responses.
- Human URL: https://docs.superviz.com/collaboration/rest-api/how-to-use
- Base URL:
https://api.superviz.com
- Rooms
- Collaboration
- Participants
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
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.
- Human URL: https://docs.superviz.com/collaboration/rest-api/how-to-use
- Base URL:
https://api.superviz.com
- Comments
- Annotations
- Collaboration
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Retrieves video meeting (huddle) statistics - duration, minutes, price, recordings, and per-participant join detail - for meetings created with the Video SDK.
- Human URL: https://docs.superviz.com/video-sdk/webhooks/meeting-stats
- Base URL:
https://api.superviz.com
- Video
- Meetings
- Huddle
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Outbound webhook notifications SuperViz POSTs to a preconfigured receiver when events occur - meeting stats available (MEETING_STATS), recording ready, and transcription ready. Modeled as AsyncAPI event messages.
- Human URL: https://docs.superviz.com/video-sdk/webhooks/meeting-stats
- Base URL:
https://api.superviz.com
- Webhooks
- Events
- Notifications
- Documentation
- OpenAPI — OpenAPI Specification
- AsyncAPI — AsyncAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
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-side REST requests via client_id and secret headers.
- Human URL: https://docs.superviz.com/getting-started/setting-up-your-account
- Base URL:
https://api.superviz.com
- Authentication
- Keys
- Tokens
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
FN: Kin Lane Email: kin@apievangelist.com