Component API Overview
This page focuses on non-plugin APIs and global route-prefix navigation. Plugin APIs are embedded in their protocol/plugin documentation pages.
Default access example: http://localhost:8180.
Non-plugin APIs (start here)
Section titled “Non-plugin APIs (start here)”| Category | Route Prefix | Description | Detailed Docs |
|---|---|---|---|
| Engine Core | /api/ | Stream management, system info, plugin state | Stream Management API |
| Config Center | /config/ | Config read/write, schema, validation | Configuration API |
| Adapter Layer | /api/web-sdk-adapters related | Web SDK adapter contracts and parameters | Web SDK Adapters |
| Global Conventions | - | Route categories, auth, response format | HTTP API Overview |
Where plugin APIs live
Section titled “Where plugin APIs live”- Protocol plugins (including embedded GB28181 APIs): Protocol Plugins
- Feature plugins (including embedded customer-service APIs): Feature Plugin Overview
- Customer service endpoints:
/en/plugins/customer-service/ - GB28181 endpoints:
/en/protocols/gb28181/
Global route-prefix navigation
Section titled “Global route-prefix navigation”| Route Prefix | Type | Description |
|---|---|---|
/api/ | Non-plugin | Engine core |
/config/ | Non-plugin | Configuration center |
/room/ | Built-in service | Room WebSocket and control |
/meeting/api/ | Plugin | Meeting plugin REST |
/customer-service/ | Plugin | Customer service plugin APIs (see plugin page) |
/gb28181/api/ | Plugin | GB28181 plugin APIs (see protocol page) |
/transcode/api/ | Plugin | Transcoding plugin APIs |
/mp4/ | Plugin | Recording plugin APIs |
/snap/ | Plugin | Snapshot plugin APIs |
/webrtc/ | Protocol plugin | WHIP/WHEP |