screens

Get a screen's live thumbnail

Get the most recently captured still image for a screen, returned as image bytes. This accepts standard API authentication, including an API key, or a short-lived asset query parameter token so the image can be loaded directly in an image tag. A screen outside your access scope returns a not-found error rather than a permission error.

Notes.

  • The response header x-captured-at carries the capture time.
get/v1/screens/{id}/live-thumbnail

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/screens/{id}/live-thumbnail
  • Auth: HTTP bearer

Path parameters

idstring required

Screen id.

Query parameters

atstring

capturedAt of a specific capture; default the newest.

Response

Success. The body is the file itself.

Changes

No recorded changes to this operation across all 1 revision of this API.