Skip to main content

Start a meeting

To start a fully featured video call all you have to do is send a single request to the Eyeson API. The Eyeson services organize video calls in rooms.


After you create a room the API provides you with an URL you can use to send a user to the Eyeson web GUI.

The web GUI is hosted by the Eyeson team and ensures regular updates with the latest features as well as a stable and well designed user experience. Any mobile visitors will be handled automatically given the choice to join the meeting via mobile applications too.

Start and Join Eyeson Room

It's incredibly easy to get started. All you need to do is implement a single request. This request creates an Eyeson MCU instance and provides you with a link to a reference web UI which can be used right away.

The Eyeson API provides Eyeson room features to all WebRTC and WebSocket capable clients. All communication with Eyeson occurs over Secure HTTP and Secure WebSocket protocols.

POST /rooms
user[name]String (required)Display name of the user


access_key: "...",
links: {
gui: "",
self: "...",
websocket: "..."
ready: false,
room: { ... },
team: { ... },
user: { ... }

Redirect your client to the URL given in the links.gui attribute, to use with the Eyeson pre-defined user interface.

$ curl -X POST \
-H "Authorization: YOUR_API_KEY" \
-d "user[name]=Bob" \