Docs API reference

Stages

The screens, projectors and video walls in your workspace. Read them to find the stage_id a session plays on.

List stages

GET /stages sessions:read

Every stage in the workspace, in the order they were added.

Parameters

limit integer query

Page size, 1–200.

1–200. Default 50
cursor string query

The next_cursor of the previous page.

Responses

200 A page of stages.
401 Missing or invalid API key.
403 The key lacks the scope, or the role is read-only.

Response fields (200)

items object[] required
10 fields in items
- id string required
- name string required
- location string
  
  The stage's venue name and space, e.g. "Main Hall · Room A".
- width integer
  
  Canvas width in pixels.
- height integer
  
  Canvas height in pixels.
- orientation string
  
  One of landscape, portrait, square
- plays_audio boolean
  
  Presenter audio plays on this stage.
- idle_story_id string or null
  
  The story it plays whenever nothing is booked; null = the idle card. Set it with PUT /stages/{id}/idle.
- languages string[]
  
  The languages the screen speaks, first = default (spec 31); empty = one. Set them with PUT /stages/{id}/interaction.
- presence object
  
  *Notice people in front of the screen* (the camera for presence rules). Set it with PUT /stages/{id}/presence.
  4 fields in presence
  - enabled boolean
  - distance string
    
    One of close, near, room
  - arrive_s number
  - leave_s number
next_cursor string or null required

Pass as cursor for the next page; null on the last page.

Request

curl "https://www.wunderframe.com/api/v1/stages?limit=50" \
  -H "Authorization: Bearer $WUNDERFRAME_API_KEY"

Response 200

{
  "items": [
    {
      "id": "stg_hall_b",
      "name": "Hall B · Main screen",
      "location": "Ground floor",
      "width": 1920,
      "height": 1080,
      "orientation": "landscape",
      "plays_audio": true,
      "idle_story_id": "sto_news_tv",
      "languages": [
        "de",
        "en",
        "fr"
      ],
      "presence": {
        "enabled": true,
        "distance": "close",
        "arrive_s": 1,
        "leave_s": 10
      }
    }
  ],
  "next_cursor": null
}

Error example

Response 401

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}