Skip to main content

Snapshot

A snapshot is an image capture of everything that's currently visible in your video meeting room - similar to taking a screenshot. It automatically captures the entire meeting canvas, including all participants and shared content, making it a useful tool for documenting important moments or information shared during meetings.

Create Snapshot​

This request creates a snapshot of the current meeting. Snapshots are saved in Eyesons cloud storage and can be downloaded from there.

POST /rooms/<access_key>/snapshot
RESPONSES 201 CREATED, 404 NOT FOUND, 410 GONE
info

Direct URLs to downloads expire, so it's better store the recording identifier and fetch a valid resource link on demand.

Get Snapshot​

GET /rooms/<access_key>/snapshots/<snapshot_id>
RESPONSES 200 OK, 404 NOT FOUND
GET /snapshots/<snapshot_id>
HEADERS Authorization
RESPONSES 200 OK, 404 NOT FOUND

Example Response​

{
  "id": "63ede760f3e015000fbe1af8",
  "name": "1609491900",
  "links": {
    "download": "https://fs.eyeson.com/meetings/<key>.jpg?..."
  },
  "creator": {
    "id": "63ede350b20526000f64376d",
    "name": "Jane Doe",
    "avatar": "https://myawesomeapp.com/images/avatar.png",
    "guest": false,
    "joined_at": "2021-01-01T09:00:00.000Z"
  },
  "created_at": "2021-01-01T09:05:00.000Z"
  "room": {
    "id": "63ede350b20526000f64376b",
    "name": "eyeson room",
    "ready": true,
    "started_at": "2021-01-01T09:00:00.000Z",
    "shutdown": false,
    "sip": {
      ...
    },
    "guest_token": "gKsiVlrvkFyL3klk1wBHLlm3"
  }
}

Retrieve list of all snapshots of a certain room​

GET /rooms/<room_id>/snapshots
HEADERS Authorization
RESPONSES 200 OK, 403 UNAUTHORIZED, 404 NOT FOUND

page​

Type: INTEGER (optional)
Fetch next set of snapshots (limit is 25)

started_at​

Type: ISO8601 Timestamp (optional)
Filter for a certain room instance (compare to started_at in room response)

Delete snapshot​

DELETE /snapshots/<snapshot_id>
HEADERS Authorization
RESPONSES 200 OK, 404 NOT FOUND