Screenshots API
Screenshots endpoints in the Brix REST API: 2 operations (GET), with auth, permissions and curl examples.
Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says No auth. The permission chip names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.
GET/v1/screenshots
List screen captures uploaded by your screens. Filter by a specific screen using the screenId query parameter. The image bytes for each screenshot are retrieved separately from GET /v1/screenshots/:id/file.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
screenId | query | string | no | Only this screen's captures. |
curl "https://api.brixsignage.com/v1/screenshots" \
-H "Authorization: Bearer $BRIX_API_KEY"Response 200 Success.
| Field | Type | Description |
|---|---|---|
data | array of object | |
data[].id | string | |
data[].screenId | string | |
data[].screenName | string | |
data[].url | string | Download path (GET /v1/screenshots/{id}/file). |
data[].capturedAt | string | ISO-8601 timestamp (UTC). |
data[].confirmedAt | string | null | |
data[].width | integer | null | |
data[].height | integer | null | |
data[].sourceWidth | integer | null | |
data[].sourceHeight | integer | null | |
data[].sizeBytes | integer | |
data[].capturedBy | "agent" | "projection" | "accessibility" | "webview" | null | |
data[].belowNative | boolean | Present and true when the capture is smaller than the panel's native resolution. |
Response 401 Missing, expired or revoked bearer token.
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
Response 5XX Server error. The body carries a `requestId` to quote to support.
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
GET/v1/screenshots/{id}/file
Download the image bytes of one screen capture.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Screenshot id. |
curl "https://api.brixsignage.com/v1/screenshots/{id}/file" \
-H "Authorization: Bearer $BRIX_API_KEY"Response 401 Missing, expired or revoked bearer token.
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
Response 404 No screenshot with this id, or its file is gone.
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
Response 5XX Server error. The body carries a `requestId` to quote to support.
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |