Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says Auth: none or Auth: no API key. The Permission line names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.
Every 4xx and 5xx response below returns this body:
| 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. |
Auth: Bearer token. Permission: creative.view.
The picture of a design another workspace shares into this one, live: the composited still. Only for an item a live share grants to the caller's workspace; any other id, a stopped share or a suspended source answers 404. The playlist and schedule editors show it for shared items.
Notes.
- What a screen playing the shared item airs: the design composited server-side as an SVG.
- The item stays read-only. Only the workspace a share names gets the picture.
| Parameter | In | Type | Required | Description |
|---|
id | path | string | yes | The id of a design another workspace shares into this one, live. |
v | query | string | no | A version stamp. A versioned URL is kept a week. |
curl "https://api.brixsignage.com/v1/shared-in/creative/{id}/thumbnail" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 401: Missing, expired or revoked bearer token.
Response 403: The token lacks the permission this operation needs (see x-brix-permission).
Response 404: No live share of this item into this workspace (never shared, Stop sharing, a suspended source, a deleted item), or it has no picture.
Response 5XX: Server error. The body carries a requestId to quote to support.
Auth: Bearer token. Permission: layout.view.
The picture of a layout another workspace shares into this one, live: the zones composite. Only for an item a live share grants to the caller's workspace; any other id, a stopped share or a suspended source answers 404. The playlist and schedule editors show it for shared items.
Notes.
- What a screen playing the shared item airs: the layout's zones composited server-side as an SVG.
- The item stays read-only. Only the workspace a share names gets the picture.
| Parameter | In | Type | Required | Description |
|---|
id | path | string | yes | The id of a layout another workspace shares into this one, live. |
v | query | string | no | A version stamp. A versioned URL is kept a week. |
curl "https://api.brixsignage.com/v1/shared-in/layout/{id}/thumbnail" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 401: Missing, expired or revoked bearer token.
Response 403: The token lacks the permission this operation needs (see x-brix-permission).
Response 404: No live share of this item into this workspace (never shared, Stop sharing, a suspended source, a deleted item), or it has no picture.
Response 5XX: Server error. The body carries a requestId to quote to support.
Auth: Bearer token. Permission: media.view.
The picture of a playlist another workspace shares into this one, live: the picture of its first file or design. Only for an item a live share grants to the caller's workspace; any other id, a stopped share or a suspended source answers 404. The playlist and schedule editors show it for shared items.
Notes.
- What a screen playing the shared item airs: the picture of its first file or design.
- The item stays read-only. Only the workspace a share names gets the picture.
| Parameter | In | Type | Required | Description |
|---|
id | path | string | yes | The id of a playlist another workspace shares into this one, live. |
v | query | string | no | A version stamp. A versioned URL is kept a week. |
curl "https://api.brixsignage.com/v1/shared-in/playlist/{id}/thumbnail" \
-H "Authorization: Bearer $BRIX_API_KEY"
Response 401: Missing, expired or revoked bearer token.
Response 403: The token lacks the permission this operation needs (see x-brix-permission).
Response 404: No live share of this item into this workspace (never shared, Stop sharing, a suspended source, a deleted item), or it has no picture.
Response 5XX: Server error. The body carries a requestId to quote to support.