nimeet Docs
中文

RTC PaaS · Docs · v1.1.0

ni-meet Documentation

ni-meet is a real-time audio and video PaaS for developers, with an Agora-compatible API: App ID / App Certificate authentication, channel and user management, Cloud Recording, bypass streaming, Media Push / Pull / Gateway, cloud transcoding, Analytics (quality and data analysis), callbacks and a REST API, with client SDKs for 16 platforms.

This page is the documentation entry point. For your first integration, read Quickstart → Token authentication → Channel management in that order. When you need exact interfaces, go straight to the REST API reference or the SDK API reference for your platform.

QuickstartCreate a project → get the App ID / secret → sign a token → join your first channel (curl + Node) Service activation and credentialsIdentity verification, project creation, the four credentials, key rotation, enabling recording and media push 16 client SDKsWeb / Electron / Android / iOS / macOS / Windows / Flutter / RN / Unity / Unreal ×2 / Cocos Creator / Mini Program / Cocos2d-x / C# / HarmonyOS REST API referenceEndpoint overview grouped by product, authentication and calling conventions, with copy-ready curl Token authenticationApp ID + Certificate, AccessToken2 semantics, renewal grace period, IM RTC Provider integration Cloud RecordingComposite / individual / Web recording, task state machine, Agora acquire→stop, quotas and queue Media Pushrtmp-converters pushing to a CDN, output URLs, migrating legacy entry_points Callback eventsSignature verification, event table 101–203, retry schedule, Webhook + reconciliation dual channel Error codesFull table of code / HTTP / sdkCode / meaning, plus the SDK error identifiers for each platform Channel managementChannel and user queries, kick, mute, role switching, ban rules and the Agora path mapping AnalyticsPrecise definitions of the four real-time metrics, alarm thresholds, usage / quality / call inspection / data insight Self-hosted deploymentDependency topology, compose stack, environment variables, health probes, backup and upgrade

How to use this documentation

  • First integration: read Getting started → Token authentication → Channel management, then pick a media service page.
  • Choose a platform: start with the platform matrix in the SDK overview, then open that platform's Quickstart and feature guide; exact signatures are in the same platform's API reference.
  • Migrating from Agora: read the migration guide and AccessToken2 semantics, then the channel-management path mapping and the SDK error numbers in Error codes.
  • Interface details: the REST and SDK API references are generated from the public interface definitions and stay in sync with the SDK and server versions.
  • Local verification: follow the Quickstart to start the service and run the sample scripts, verifying the full path from issuing a token to joining a channel.

Relationship to the Agora API

ni-meet keeps the API semantics, error codes and developer experience of Agora RTC: client SDK method names, signatures and events follow the Agora 4.x public API, and REST paths and callback event codes are compatible. When migrating, the main changes are the service endpoint and where tokens are issued; application code rarely needs to change. See Migrating from Agora.

Generated by the documentation build pipeline · 2026-10-31 01:24:02 UTC · Documentation center v1.1.0.

Content follows the public API definitions.

ni-meet is a self-hosted RTC PaaS with a LiveKit-based media plane (Apache-2.0) and an Agora-compatible API.