Eyeson API Demo

Eyeson API 101

Create your first video call with Eyeson API

Eyeson API is a powerful video conferencing service with some outstanding features. It was created to be integrated into your calls within minutes and give you the best quality with minimal requirements.

Creating the first call

1. Take the demo key from your form fillout or an API key you created with your free account and paste it below.

2. Enter the name of the person you want to start the meeting. Most probably this is you.

3. Press the request button & get a response.

4. In the middle of the response you will see the GUI link to the meeting. Join the meeting.

Limits of the demo API key

The demo API key is limited to a certain number of concurrent calls. We recommend you use one of your project API keys if you can not connect to the service.

What you can expect on this page

You will start a meeting with your API key.
You will be able to join this meeting.
You will see the JSON response of the creation call.
You will be able to do some basic layout changes because of the access key you got when creating the room.
You will learn the basics of the inner workings of the Eyeson API.

Start a Meeting

The link to the eyeson GUI should appear here.

The Access Key of the Meeting should appear here.

The unfiltered response to the cURL request should appear here.

Change the Stream Layout

With an Access Key you can change the settings of a live video call.

The layout of the meeting hasn't been changed for 5 seconds.

From your local Machine

In a Terminal

Microsoft Windows

First, run a Windows Terminal by searching for "cmd".
Type in "SET API_Key=", copy/paste your API key and press Enter.

SET API_Key=ABCDEFGHIJKLMNO1234567890

Then copy and paste the following and enter.

curl -X POST ^
-H "Authorization: %API_Key% " ^
-d "user[name]=Bob" ^
"https://api.eyeson.team/rooms"

MacOS

Open a terminal.
Type in "ENV API_KEY=", copy/paste your API key and press enter.

ENV API_Key=ABCDEFGHIJKLMNO1234567890

Then copy and paste the following and enter.

$ curl -X POST \  
-H "Authorization: $API_Key " \
-d "user[name]=Bob" \ 
"https://api.eyeson.team/rooms"

When you create a room, an access_key and a guest_token get generated. You need the access_key to change room parameters or to give/restrict access to functionalities.

EXAMPLE | Remove the names of all participants

SET ACCESS_KEY=l9qGv68lp57yNZwMMvwehSao

curl -X POST ^
-d "options[show_names]=false" ^
"https://api.eyeson.team/rooms/%ACCESS_KEY%/layout"

EXAMPLE | Position speakers or sources in fixed positions

curl -X POST ^
  -d "users[]=USER_ID_A" ^
  -d "users[]=USER_ID_B" ^
  -d "users[]=USER_ID_C" ^
  -d "users[]=USER_ID_D" ^
  "https://api.eyeson.team/rooms/%ACCESS_KEY%/layout"

Use the guest_token received from the room creation to set any number of guest users. This allows you to offer a quick join method to a meeting.

EXAMPLE | Put a guest user in the room

SET GUEST_TOKEN=XWukqEdIUpEQTEFjd0dkW7Uf

curl -X POST ^
-d "name=John Doe" ^
"https://api.eyeson.team/guests/%GUEST_TOKEN%"

A guest user only has access to a running meeting session. Once a meeting ends, the guest user cannot join any future meetings in this room.

You can also close rooms. Once you close the room all the data connected with the room – like recordings, snapshots and similar – will be lost if not transferred somewhere else before.

Anatomy of rooms

How rooms are built

One of the things you will like is the layered approach we took with Eyeson API. A room consists of:

a background layer
the call participants layer
and a foreground layer.

So there is plenty of room to make a room subject to your corporate identity or showing additional information from other APIs, like e.g. a weather API or the schedule of the nearby train station.

There are some examples on Github.

All basic web conferencing functionalities can be accessed via API. This means, that you can: