All endpoints below use M2M OAuth2 authentication.
Authentication happens via the https://id.beamxr.io/ URL.
Every other endpoint call happens via the https://enterprise-api.beamxr.io/ URL.
Authentication
| Endpoint | Method | Description |
|---|
https://id.beamxr.io/connect/token | POST | Get M2M access token (client credentials) |
/poolusers/newtoken | GET | Generate a pool user token for the Unity SDK |
Sessions & Cohorts
| Endpoint | Method | Description |
|---|
https://enterprise-api.beamxr.io/sessions/{SessionId} | GET | Get session details and events |
/sessions/active | GET | List active sessions |
/cohorts/{TenantCohortId}/sessions | GET | List sessions in a cohort |
/cohorts/{TenantCohortId}/active | GET | List active sessions in a cohort |
Streaming
| Endpoint | Method | Description |
|---|
/sessions/{SessionId}/streams/{StreamingSessionId}/Watch | GET | Get stream URL and token for viewing |
Commands
| Endpoint | Method | Description |
|---|
/sessions/{SessionId}/realtime/commands | POST | Send a command (camera, text, custom variables) |
/sessions/{SessionId}/realtime/commands/stream | POST | Start stream remotely |
/sessions/{SessionId}/realtime/commands/stream/stop | PUT | Stop stream remotely |
/sessions/{SessionId}/realtime/commands/record | PUT | Start recording remotely |
/sessions/{SessionId}/realtime/commands/record/stop | PUT | Stop recording remotely |
Recordings
| Endpoint | Method | Description |
|---|
/sessions/{SessionId}/recordings | GET | List recordings for a session |
/recording/{RecordingId} | GET | Get a specific recording |