Component API Overview
This page lists non-plugin API references and global route prefixes. Plugin APIs live in protocol/feature plugin docs.
Default base URL: http://localhost:8180.
Non-Plugin APIs (start here)
Section titled “Non-Plugin APIs (start here)”| Category | Prefix | Description | Docs |
|---|---|---|---|
| Engine core | /v6/api/ | Streams, aliases, tasks, proxies, system | Stream API |
| Config framework | /config/ | Schema, HTML pages, incremental PUT | Config API |
| Runtime config | /api/config/ | DB persistence and reload | Config API |
| Client adapters | (no HTTP prefix) | Agora/Zego Web SDK packages | Web SDK adapters |
| Overview | — | Auth, response conventions | HTTP API overview |
Where to Find Plugin APIs
Section titled “Where to Find Plugin APIs”- Protocol plugins (incl. GB28181): Protocols
- Feature plugins: Plugins overview
- Live rooms:
/live/*— Live plugin - Customer service:
/customer-service/*— Customer service - GB28181:
/gb28181/api/*— GB28181
Global Route Prefixes
Section titled “Global Route Prefixes”| Prefix | Type | Description |
|---|---|---|
/v6/api/ | Non-plugin | Engine REST API |
/config/ | Non-plugin | Config framework |
/api/config/ | Non-plugin | Runtime config (DB) |
/room/ | Built-in | Room WebSocket signaling |
/live/ | Plugin | Live REST |
/meeting/api/ | Plugin | Meeting REST |
/customer-service/ | Plugin | Customer-service API |
/gb28181/api/ | Plugin | GB28181 API |
/transcode/api/ | Plugin | Transcode API |
/mp4/ | Plugin | Recording API |
/snap/ | Plugin | Snapshot API |
/webrtc/ | Protocol | WHIP/WHEP |