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
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": "67ed1d18d06e7a9b10bf0461",
    "name": "1743592728",
    "links": {
      "download": "https://fs.eyeson.com/meetings/67ed1d058bcb8e2282fad81c/snapshots/1743592728.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AH07FBAZO9IYS38J6742%2F20250402%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250402T111932Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=57956c85e4b73fed07bd6f2f631bfb156052be09fdd54ce846240d4aa8abdf23&COMAPI-TOK=bc7bXUJbV9t7LpqE9GtPJ9Up"
    },
    "creator": {
      "id": "67ed1d058bcb8e2282fad81d",
      "name": "John Doe",
      "avatar": null,
      "guest": false,
      "joined_at": "2025-04-02T11:18:35.770Z"
    },
    "created_at": "2025-04-02T11:18:48.145Z",
    "room": {
      "id": "67ed1d058bcb8e2282fad81b",
      "name": "Jane Doe",
      "ready": true,
      "started_at": "2025-04-02T11:18:29.763Z",
      "shutdown": false,
      "guest_token": "A78hsu4SyUMpt474j25Ozhsw"
    }
  },
  {
    "id": "67ed1d0fd06e7a9b10bf0460",
    "name": "1743592719",
    "links": {
      "download": "https://fs.eyeson.com/meetings/67ed1d058bcb8e2282fad81c/snapshots/1743592719.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AH07FBAZO9IYS38J6742%2F20250402%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250402T111932Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=ce80308d0b47ad616e1dd572aac4e2b7cc47d960029a8c7f77432d8646ceb349&COMAPI-TOK=Asoddejq7F4FgnA7ZdOctCrn"
    },
    "creator": {
      "id": "67ed1d058bcb8e2282fad81d",
      "name": "John Doe",
      "avatar": null,
      "guest": false,
      "joined_at": "2025-04-02T11:18:35.770Z"
    },
    "created_at": "2025-04-02T11:18:39.225Z",
    "room": {
      "id": "67ed1d058bcb8e2282fad81b",
      "name": "Jane Doe",
      "ready": true,
      "started_at": "2025-04-02T11:18:29.763Z",
      "shutdown": false,
      "guest_token": "A78hsu4SyUMpt474j25Ozhsw"
    }
  }
]
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 snapshots, where the room instance was started at the current timestamp. This value origins from the meeting start response.

since​

Type: ISO8601 Timestamp (optional)
Filter for snapshots, where the room instance was running since the timestamp.

until​

Type: ISO8601 Timestamp (optional)
Filter for snapshots, where the room instance was running before the 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