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
Req/Res Example: Create Snapshot
Request
curl -X POST "https://api.eyeson.team/rooms/$ACCESS_KEY/snapshot"
Response
No Response
warning

Snapshots are stored for up to 14 days. Afterwards they get destroyed.

Get Snapshot​

GET /rooms/`ACCESS_KEY`/snapshots/`SNAPSHOT_ID`
RESPONSES 200 OK, 404 NOT FOUND
Req/Res Example: Get Snapshot of a running meeting
Request
curl -X GET "https://api.eyeson.team/rooms/$ACCESS_KEY/snapshots/$SNAPSHOT_ID"
Response
{
  "id": "67dabc51f71a86c897058e37",
  "name": "1742388305",
  "links": {
    "download": "https://fs.eyeson.com/meetings/...."
  },
  "creator": {
    "id": "67dabc43f71a86c897058e36",
    "name": "Demo",
    "avatar": null,
    "guest": false,
    "joined_at": "2025-03-19T12:44:53.837Z"
  },
  "created_at": "2025-03-19T12:45:05.275Z",
  "room": {
    "id": "demo",
    "name": "API magic",
    "ready": true,
    "started_at": "2025-03-19T12:44:51.555Z",
    "shutdown": false,
    "guest_token": "cuXvirwVKNcbGoAAOY7IuzF4"
  }
}
GET /snapshots/`SNAPSHOT_ID`
HEADERS Authorization
RESPONSES 200 OK, 404 NOT FOUND
Req/Res Example: Get Snapshot
Request
curl -X GET -H "Authorization: $API_KEY" "https://api.eyeson.team/snapshots/$SNAPSHOT_ID"
Response
{
  "id": "67dabc51f71a86c897058e37",
  "name": "1742388305",
  "links": {
    "download": "https://fs.eyeson.com/meetings/...."
  },
  "creator": {
    "id": "67dabc43f71a86c897058e36",
    "name": "Demo",
    "avatar": null,
    "guest": false,
    "joined_at": "2025-03-19T12:44:53.837Z"
  },
  "created_at": "2025-03-19T12:45:05.275Z",
  "room": {
    "id": "demo",
    "name": "API magic",
    "ready": true,
    "started_at": "2025-03-19T12:44:51.555Z",
    "shutdown": false,
    "guest_token": "cuXvirwVKNcbGoAAOY7IuzF4"
  }
}
warning

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

Retrieve list of all snapshots of a room​

GET /rooms/`ROOM_ID`/snapshots
HEADERS Authorization
RESPONSES 200 OK, 403 UNAUTHORIZED, 404 NOT FOUND
RECOMMENDED started_at
Req/Res Example: Retrieve list of all Snapshots
Request
curl -X GET -H "Authorization: $API_KEY" "https://api.eyeson.team/rooms/$ROOM_ID/snapshots"
Response
{
  "id": "67dbe34373a62cb61f882381",
  "name": "1742463811",
  "links": {
    "download": "https://fs.eyeson.com/meetings/67dbe2d860fcb88bbf8826d8/snapshots/1742463811.jpg?..."
  },
  "creator": {
    "id": "67dbe2d860fcb88bbf8826d9",
    "name": "Snapshot Tester",
    "avatar": null,
    "guest": false,
    "joined_at": "2025-03-20T09:41:46.642Z"
  },
  "created_at": "2025-03-20T09:43:31.849Z",
  "room": {
    "id": "67dbe2d860fcb88bbf8826d7",
    "name": "Snapshot Room",
    "ready": true,
    "started_at": "2025-03-20T09:41:44.375Z",
    "shutdown": false,
    "guest_token": "AEqu8jMZY7SCUUAuQxKqwYvT"
  }
},
{
  "id": "67dbe338fe13f2745410bcf7",
  "name": "1742463800",
  "links": {
    "download": "https://fs.eyeson.com/meetings/67dbe2d860fcb88bbf8826d8/snapshots/1742463800.jpg?..."
  },
  "creator": {
    "id": "67dbe2d860fcb88bbf8826d9",
    "name": "Snapshot Tester",
    "avatar": null,
    "guest": false,
    "joined_at": "2025-03-20T09:41:46.642Z"
  },
  "created_at": "2025-03-20T09:43:20.941Z",
  "room": {
    "id": "67dbe2d860fcb88bbf8826d7",
    "name": "Snapshot Room",
    "ready": true,
    "started_at": "2025-03-20T09:41:44.375Z",
    "shutdown": false,
    "guest_token": "AEqu8jMZY7SCUUAuQxKqwYvT"
  }
},
{
  "id": "67dbe316fe13f2745410bcf6",
  "name": "1742463766",
  "links": {
    "download": "https://fs.eyeson.com/meetings/67dbe2d860fcb88bbf8826d8/snapshots/1742463766.jpg?..."
  },
  "creator": {
    "id": "67dbe2d860fcb88bbf8826d9",
    "name": "Snapshot Tester",
    "avatar": null,
    "guest": false,
    "joined_at": "2025-03-20T09:41:46.642Z"
  },
  "created_at": "2025-03-20T09:42:46.870Z",
  "room": {
    "id": "67dbe2d860fcb88bbf8826d7",
    "name": "Snapshot Room",
    "ready": true,
    "started_at": "2025-03-20T09:41:44.375Z",
    "shutdown": false,
    "guest_token": "AEqu8jMZY7SCUUAuQxKqwYvT"
  }
}
info

Newest Snapshots are on top of the list.

page​

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

started_at​

Type: ISO8601 Timestamp (optional)
Filter for recordings, where the room instance was running at the current timestamp.

Delete snapshot​

DELETE /snapshots/`SNAPSHOT_ID`
HEADERS Authorization
RESPONSES 200 OK, 404 NOT FOUND
Req/Res Example: Delete Snapshot
Request
curl -X DELETE -H "Authorization: $API_KEY" "https://api.eyeson.team/snapshots/$SNAPSHOTS_ID"
Response
No Response