Basic Concepts

Core building blocks for real-time rooms, recording, and event management.

Overview

MediaSFU is a cloud platform for building real-time experiences: meetings, calls, recordings, and live streaming workflows. This page gives you the core mental model for the API-first path.

Recommended for SDK users: keep your HTTP surface small (create/join/get, optionally delete), then let SDK methods and socket events drive runtime behavior.

Using one of our SDKs? You can skip the detailed docs and head straight to the quick usage page.

Modern docs path: for clearer architecture and better implementation examples, use the Modern Ease of Use Guide.

New to MediaSFU or not building with code? Start with the User Guide. It covers the same concepts in a non-technical, dashboard-first format.

The sections below focus on API workflows, room lifecycle, and integration-level behavior.

Every documentation page has a sandbox to test the API calls and see the responses.

The Rooms section provides a detailed guide on creating and managing rooms and might be a good place to start.

In the Rooms guide, prioritize the core flow first: create, join, get/list rooms (and optionally delete for cleanup). This is effectively the HTTP room-control surface exposed by MediaSFU (outside calls-specific flows).

Most in-room controls after join (media toggles, moderation, updates, and live coordination) are socket-driven and already handled by SDK methods. In practice, there are no equivalent extra room HTTP listeners for those runtime actions.

Some low-level websocket examples may evolve over time. Always cross-check with the latest SDK behavior and event reference when implementing production logic.

Platform Documentation Links:

Flutter Documentation React.js Documentation Angular Documentation React Native (Expo) Documentation React Native (CLI) Documentation Vue.js Documentation Electron Documentation Plain JavaScript Documentation

Video Learning Resources

Get started quickly with our video tutorial series. Perfect for visual learners and those who want to see MediaSFU in action.

Platform Introduction & Overview

Start your MediaSFU journey with this introduction covering platform capabilities, use cases, and development approaches.

Getting StartedPlatform OverviewBest Practices

Complete Tutorial Series

02Account Setup & Dashboard Navigation 03Room Creation & Integration Basics 04Sandbox & API Documentation

View Complete Playlist

🔍

Overview

Understanding MediaSFU Rooms

Welcome to the Rooms Overview. In MediaSFU, room lifecycle management follows a simple API flow: create the room, add members, then connect participants through realtime sockets.

Room Allocation: Create a room with the required configuration and host details. A successful response returns host credentials (secret/token) used to secure access.

Member Addition: Add participants through API requests and issue member credentials so each user can join securely with the correct role.

Realtime Communication: After allocation and membership setup, room activity runs over sockets for signaling, media state updates, and in-room coordination.

Once connected, clients publish and consume events related to media capture, device state, and room lifecycle changes. If your use case is recording-heavy, the later sections cover the recommended patterns for stable recording sessions.

For most teams, create + member onboarding is enough to get started quickly. You can layer on advanced controls as your product requirements grow.

Note: If you are using an official SDK, you can focus on the core room APIs first. The deeper sections are mainly for custom SDK builders or unsupported language environments.

Real-time audio and video communication
Screen sharing and presentation capabilities
Recording and streaming features
Advanced room management tools
Scalable infrastructure for any size event

Domains Documentation

Learn about managing and utilizing domains on MediaSFU, including registration, verification, and control functions.

Domains Overview

Managing domains on MediaSFU is a crucial aspect of controlling API access and facilitating institution logins. Each user can register a specific number of domains based on their subscription allowances.

Important: Once a domain is registered, API requests will only be accepted from this registered domain for production API access. It is essential to register a domain to be able to use production API access.

Requests from unregistered domains or localhost will only be allowed for development and sandbox API access.

Institution Login Feature

The domain registration process allows users to enable or disable institution logins for the registered domain. Enabling institution login means that anyone with an email credential@thedomainname can log in or register, provided they authenticate successfully. These users become sub-users under the organization (user) that registered the domain.

Domain Management: You can easily register and manage domains on MediaSFU using our API. The following sections provide details on how to register (create), update, and delete domains using our API.

Event Settings Documentation

Learn about managing and configuring event settings on MediaSFU for optimal meeting experiences.

Overview

Users can define parameters such as the number of participants per page, preferred video orientation, and other relevant settings. This streamlines the event creation process, ensuring that each event aligns with the user's preferred configuration.

Follow the steps below to create (add), update, and list(get) events settings using MediaSFU's API.

Try it out

Open New Tab

Use the Sandbox to experiment with the API, modify parameters, and analyze responses for different scenarios.

Recording Settings Documentation

Learn about managing and configuring recording settings on MediaSFU for optimal recording experiences.

Overview

Users can define parameters such as the number of participants per page, preferred video orientation, and other relevant settings. This streamlines the recording creation process, ensuring that each recording aligns with the user's preferred configuration.

Note: Changes to adding watermark to be true requires a watermark image to be uploaded to the server. The image should be a PNG file and can only be uploaded using the MediaSFU dashboard. So it's unadvisable to set the watermark to true using the API.

Follow the steps below to create (add), update, and list(get) recordings settings using MediaSFU's API.

Try it out

Open New Tab

Use the Sandbox to experiment with the API, modify parameters, and analyze responses for different scenarios.

Sub-Users Management

Guide to managing sub-users in MediaSFU

Sub-Users Overview

Sub-users operate within the same account, sharing the balance and credentials automatically. This is useful for institutions, companies, or individual users who want to use the same account under different aliases or for accounting purposes.

As the primary user, you have full control over sub-users, including the ability to manage and monitor their usage across your organization or team.

Key Benefits:

Unified account management
Shared balance and credentials
Enhanced collaboration capabilities
Flexible user organization

Getting Started

Follow the steps below to get started with sub-users using our API:

Recordings Management

Guide to managing recordings in MediaSFU

Recordings Overview

MediaSFU's recording system allows you to capture and manage video recordings from your events, meetings, and webinars. The recordings feature provides full functionality for listing, accessing, and managing recorded content.

Important Note: This documentation specifically covers getting recordings from MediaSFU API. For more information on how to record a room, please refer to the Rooms Documentation here.

Key Features:

Automatic recording of events and meetings
High-quality video and audio capture
Secure storage and access control
Easy retrieval and management via API

Getting Started

To get recordings from MediaSFU, follow these simple steps using our API:

Use the GET endpoint to retrieve and manage your recordings. The system provides detailed information about each recording including duration, file size, creation date, and access URLs.

AI Credentials Management

Guide to managing AI credentials in MediaSFU

AI Credentials Overview

AI Credentials in MediaSFU allow you to securely store and manage authentication information for AI services like LLM, TTS, and STT providers.

Key Features:

Secure Storage: API keys and tokens are stored securely
Service Integration: Compatible with OpenAI, Deepgram, and other providers
User Scoping: Can be assigned to specific sub-users
Pipeline Reference: Use nickName to reference credentials in pipelines

Management Capabilities

Create, update, delete, and list AI credentials through our REST API endpoints with support for VISION and VOICE services.

SIP Configuration Overview

Understanding SIP configurations and their role in MediaSFU

Configuration Requirements

Essential parameters and data needed for SIP setup

Creating SIP Configurations

Step-by-step guide to creating new SIP configurations

Updating Configurations

How to modify existing SIP configurations

Listing Configurations

Retrieving and managing your SIP configurations

Deleting Configurations

Safely removing unwanted SIP configurations

Number Verification

Verifying contact numbers for active routing

API Sandbox

Interactive testing environment for SIP configuration APIs

SIP Configuration Management

Guide to managing SIP configurations in MediaSFU

SIP Configuration Overview

SIP (Session Initiation Protocol) Configurations are essential for connecting your MediaSFU platform to the wider telephony world. They allow you to manage your VoIP trunks, link them to specific contact numbers (DIDs), and define how incoming and new calls are handled.

With SIP Configurations, you can:

Connect to various SIP providers/carriers.
Route incoming calls based on the DID.
Enable and manage outbound calling capabilities.
Integrate automated responses using IVR, Playback, or sophisticated AI Agents.
Define security parameters like IP whitelisting/blacklisting and geo-restrictions.
Customize call recording, audio prompts, and callback options.

Each configuration is tied to a primary `contactNumber` and can be associated with a main user or a specific subuser account. Contact numbers require verification before they can be used for active call routing.

Widget System Overview

Understanding how MediaSFU widgets work end-to-end

Widget System Overview

MediaSFU widgets are embeddable components that add real-time communication features to any website. No coding required for basic integration.

The Complete Flow

1. Create Widget

Configure in Dashboard → Widgets

→

2. Backend Stores

Widget key + config securely saved

→

3. Get Embed Code

Platform-specific code generated

→

4. Add to Site

Copy-paste to your website

→

5. Widget Auth

Domain validated, token issued

→

6. Live!

Widget functional on your site

For Non-Developers

Copy-paste embed codes, visual configuration, no coding required.

For Developers

npm packages for React/Vue, full API access, event callbacks.

For Enterprise

Custom UI, webhooks, SSO integration, white-label options.

Overview

Real-time translation for meetings

Real-Time Translation Overview

MediaSFU's real-time translation enables participants in meetings to speak in their native language while others hear the translation in their preferred language.

Speech Recognition

Automatic speech-to-text converts spoken words into text in real-time.

AI Translation

Advanced LLMs translate text while preserving context and meaning.

Voice Synthesis

Natural-sounding text-to-speech delivers translations as audio.

Per-Participant

Each participant chooses their listening language independently.

How It Works

1

Speaker talks

Audio captured and streamed

→

2

STT Processing

Speech converted to text

→

3

LLM Translation

Text translated to target languages

→

4

TTS Output

Translated audio delivered

Use Cases

Global Team Meetings — Team members in different countries participate in their native languages
Customer Support — Support agents communicate with customers regardless of language barriers
International Webinars — Presenters reach global audiences with real-time translation
Multilingual Classrooms — Students learn in their preferred language while instructors teach in theirs

Overview

What are disposable API keys?

Disposable API Keys Overview

Disposable API keys are temporary, scoped credentials that allow third parties to perform specific operations on your account without exposing your main API key.

Time-Limited

Keys expire after a configurable duration (1 day to 1 year, or never).

Permission-Scoped

Restrict to specific operations (create rooms, make calls, etc.).

Domain-Locked

Only works from specified domains for additional security.

Revocable

Instantly revoke access at any time if compromised.

How It Works

1

You create key

Define permissions & domains

→

2

Share with partner

They integrate the key

→

3

Partner uses API

Limited to allowed ops

→

4

Key expires/revoked

Access ends automatically

This page is developer-focused.

Basic Concepts

Overview

Platform Documentation Links:

Video Learning Resources

Platform Introduction & Overview

Complete Tutorial Series

Rooms Documentation

Overview

Domains Documentation

Domains Overview

Institution Login Feature

Event Settings Documentation

Event Settings Documentation

Overview

Try it out

Recording Settings Documentation

Recording Settings Documentation

Overview

Try it out

Sub-Users Documentation

Sub-Users Management

Sub-Users Overview

Getting Started

Recordings Documentation

Recordings Management

Recordings Overview

Getting Started

AI Credentials Documentation

AI Credentials Documentation

AI Credentials Management

AI Credentials Overview

Management Capabilities

AI Credentials Sandbox

What would you like to do?

Create Credential

Update Credential

Get Credentials

Delete Credential

SIP Configuration Documentation

Sections

SIP Configuration Management

SIP Configuration Overview

Widget System Overview

Widget System Overview

The Complete Flow

1. Create Widget

2. Backend Stores

3. Get Embed Code

4. Add to Site

5. Widget Auth

6. Live!

For Non-Developers

For Developers

For Enterprise

Overview

Real-Time Translation Overview

Speech Recognition

AI Translation

Voice Synthesis

Per-Participant

How It Works

Use Cases

Overview

Disposable API Keys Overview

Time-Limited

Permission-Scoped

Domain-Locked

Revocable

How It Works