API Endpoints

tip

Some requests have specific requirements. Refer to the linked examples for detailed guidance.

Meeting Settings

Endpoint	Method	Description	Examples
/rooms	POST	Initiates a session. The meeting (video stream), starts only when the user joins by opening the GUI link in a browser.	/meeting-room
/rooms/ACCESS_KEY	GET	Fetches details of current room.	/meeting-room
/rooms/ACCESS_KEY	DELETE	Ends the current meeting.	/meeting-room
/rooms	GET	Receive a list of current meetings	/meeting-room
/rooms/ROOM_ID	DELETE	Ends the meeting.	/meeting-room
/rooms/ACCESS_KEY/lock	POST	Locks the room, preventing users to join.	/meeting-room
User Management
/rooms/ACCESS_KEY/users	GET	Lists all participants of the meeting.	/users
/rooms/ACCESS_KEY/users/USER_ID	GET	Fetches user details.	/users
/rooms/ACCESS_KEY/users/USER_ID	DELETE	Removes user from meeting.	/users
/guests/GUEST_TOKEN	POST	Registers a guest user.	/guests
Permanent Meeting
/permalink	POST	Creates a permanent link.	/permalink
/permalink	GET	Lists all permalinks.	/permalink
/permalink/PERMALINK_ID	GET	Fetches identified permalink.	/permalink
/permalink/PERMALINK_ID	PUT	Updates a permalink.	/permalink
/permalink/PERMALINK_ID	DELETE	Removes a permalink.	/permalink
/permalink/PERMALINK_ID/users	POST	Registers host user to permalink.	/permalink
/permalink/PERMALINK_ID/users/USER_ID	DELETE	Removes host user from permalink.	/permalink
/permalink/USER_ID	GET	Receives information about the room.	/permalink
/permalink/USER_ID	POST	Starts meeting from permalink.	/permalink

Meeting Activities

Some of the most frequently used features are listed here. They are primarily designed to support the creation of a custom Virtual Situation Room during an active meeting, allowing developers to tailor the stream content in real time based on the needs of the incident with the /layout and /layers endpoints.

Endpoint	Method	Description	Examples
/rooms/ACCESS_KEY/messages	POST	Text message in the meeting chat.	/messages
Layout Management
/rooms/ACCESS_KEY/layers	POST	Adds an image layer to the meeting.	/layers
/rooms/ACCESS_KEY/layers/INDEX	DELETE	Removes an image layer.	/layers
/rooms/ACCESS_KEY/layout	POST	Updates layout coordinates.	/meeting-layout
Playbacks
/rooms/ACCESS_KEY/playbacks	POST	Adds an audio/video playback to the meeting.	/playbacks
/rooms/ACCESS_KEY/playbacks/PLAY_ID	DELETE	Removes an audio/video playback.	/playbacks
Broadcasting
/rooms/ACCESS_KEY/broadcasts	POST	Starts to broadcast on a platform with a stream URL.	/broadcasts
/rooms/ACCESS_KEY/broadcasts	PUT	Updates the public URL for viewers.	/broadcasts
/rooms/ACCESS_KEY/broadcasts	DELETE	Stops the broadcast.	/broadcasts

Meeting Documentation

Endpoint	Method	Description	Examples
Video Recordings
/rooms/ACCESS_KEY/recording	POST	Starts to record the meeting.	/recording
/rooms/ACCESS_KEY/recording	DELETE	Stops the recording process.	/recording
/recordings/RECORDING_ID	GET	Receives a public link to the recording.	/recordings
/recordings/RECORDING_ID	DELETE	Deletes a recording.	/recordings
/rooms/ROOM_ID/recordings	GET	Fetches a list of all recordings of a certain room.	/recordings
Image Snapshots
/rooms/ACCESS_KEY/snapshot	POST	Takes a snapshot of the meeting.	/snapshot
/snapshots/SNAPSHOT_ID	GET	Receives a public link to the snapshot with an API_KEY.	/snapshots
/rooms/ACCESS_KEY/snapshots/SNAPSHOT_ID	GET	Receives a public link to the snapshot.	/snapshots
/snapshots/SNAPSHOT_ID	DELETE	Deletes a snapshot.	/snapshots
/rooms/ROOM_ID/snapshots	GET	Fetches a list of all snapshots of a certain room.	/snapshots

Forward Video Streams

info

This feature is primarily used to deliver video streams to external AI systems in the cloud.

Endpoint	Method	Description	Examples
/rooms/ROOM_ID/forward/source	POST	Forwards a video source (webcam, drone, etc.).	/forward
/rooms/ROOM_ID/forward/mcu	POST	Forwards the entire video stream of the meeting	/forward
/rooms/ROOM_ID/forward/playback	POST	Forwards a running audio/video playback.	/forward
/rooms/ROOM_ID/forward/FORWARD_ID	DELETE	Ends a forwarding process.	/forward

Webhooks

This is one of the methods to stay up to date with room changes and receive live data related to ongoing meetings. An alternative is the Meeting Observer, which provides a one way WebSocket connection for receiving updates.

Endpoint	Method	Description	Examples
/webhooks	POST	Registers a webhook.	/webhooks
/webhooks	GET	Fetches currently registered webhooks.	/webhooks
/webhooks/WEBHOOK_ID	DELETE	Removes a webhook.	/webhooks