Skip to main content

API Reference

Look up exact signatures, types and endpoints. There are two kinds of reference:

  • HTTP APIs for server-side calls that need no SDK, such as creating rooms.
  • SDK references generated from each package, for exact props, types and methods.

For step-by-step integration, start with the Quickstart or your SDK guide.

HTTP APIs​

All HTTP calls authenticate with Authorization: Bearer <api-username>:<api-key> and belong on your server, never in a browser or mobile app.

TaskEndpointGuide
Every resource: fields, examples, responses and errorshttps://mediasfu.com/v1/…HTTP API reference
Create, join or end a roomPOST https://mediasfu.com/v1/roomsRooms API
Stream in and out with WHIP, WHEP and HLS/v1/meetings/:meetingID/…Streaming
Add participants that publish and receive over HTTP/v1/meetings/:meetingID/external-sessionsParticipants over HTTP
Control AI calls from your serverAI call-control endpointsAI call control
Try any request liveAPI Sandbox

SDK references​

PackageBest forAPI docs
mediasfu-sharedShared core logic across frameworksOpen API reference
mediasfu-reactjsWeb apps with full React controlOpen API reference
mediasfu-angularAngular apps with DI-based wrappersOpen API reference
mediasfu-reactnativeBare React Native mobile appsOpen API reference
mediasfu-reactnative-expoExpo-managed mobile appsOpen API reference
mediasfu-vueVue apps with composition-friendly APIsOpen API reference
mediasfu_sdkFlutter apps across mobile, web, and desktopOpen staged Dartdoc and pub.dev
com.mediasfu:mediasfu-sdk-android / com.mediasfu:mediasfu-sdkNative Android and KMP Compose appsOpen staged Dokka/KDoc and Maven Central
MediaSFU SwiftNative iOS apps with Swift/UIKit/SwiftUI entry pointsApple SDK README and USAGE.md
MediaSFU UnityUnity apps, games, simulations, and interactive 3D experiencesUnity SDK README and API contract

How to choose the right reference​

  • Start with SDK Guides when you are choosing a package or setting up a first room.
  • Use this overview when you know the package family but need the right reference destination.
  • Open Generated API Docs when you need exact generated TypeDoc, Dartdoc, or Dokka/KDoc pages.
  • Open Choose your UI mode when you are deciding between prebuilt UI, UI overrides, custom components, or headless mode.
  1. Start with /sdks to choose the right framework package.
  2. Read the relevant SDK guide for quickstart, backend mode, and framework-specific setup.
  3. Jump into the package API site when you need exact types, method signatures, or generated symbol listings.