# Shared in

> For AI agents: the full docs index is at https://brixsignage.com/llms.txt, and every page has a markdown twin (add .md to the path).

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](https://brixsignage.com/developers/authentication.md), [Errors and rate limits](https://brixsignage.com/developers/errors-and-rate-limits.md) and [Pagination](https://brixsignage.com/developers/pagination.md).

- [GET /v1/shared-in/creative/{id}/thumbnail](#get-v1-shared-in-creative-id-thumbnail)
- [GET /v1/shared-in/layout/{id}/thumbnail](#get-v1-shared-in-layout-id-thumbnail)
- [GET /v1/shared-in/media/{id}/thumbnail](#get-v1-shared-in-media-id-thumbnail)
- [GET /v1/shared-in/playlist/{id}/thumbnail](#get-v1-shared-in-playlist-id-thumbnail)

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. |

## GET /v1/shared-in/creative/{id}/thumbnail

Get the picture of a design shared into this workspace

Get a preview image of a design that a different workspace shares with yours. The item stays read-only. If the share has stopped or the item has no picture, the call returns a not-found error.

**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.

Auth: Bearer token. Permission: `creative.view`.

Parameters:

| Name | 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. |

```bash
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.

## GET /v1/shared-in/layout/{id}/thumbnail

Get the picture of a layout shared into this workspace

Get a preview image of a layout that a different workspace shares with yours. The image shows the zones of the layout. If the share has stopped or the item has no picture, the call returns a not-found error.

**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.

Auth: Bearer token. Permission: `layout.view`.

Parameters:

| Name | 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. |

```bash
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.

## GET /v1/shared-in/media/{id}/thumbnail

Get the picture of a media shared into this workspace

Get a preview image of a file that a different workspace shares with yours: the poster image of a video or a small copy of an image. The call never returns the file itself. If the share has stopped or the file has no picture, the call returns a not-found error.

**Notes.**
- What a screen playing the shared item airs: the file's poster still, or a 320 px copy of an image. Never the file itself; a font, audio or web page answers 404.
- The item stays read-only. Only the workspace a share names gets the picture.

Auth: Bearer token. Permission: `media.view`.

Parameters:

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | The id of a media another workspace shares into this one, live. |
| `v` | query | string | no | A version stamp. A versioned URL is kept a week. |

```bash
curl "https://api.brixsignage.com/v1/shared-in/media/{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.

## GET /v1/shared-in/playlist/{id}/thumbnail

Get the picture of a playlist shared into this workspace

Get a preview image of a playlist that a different workspace shares with yours. The image is the picture of the first file or design in the playlist. If the share has stopped or the playlist has no picture, the call returns a not-found error.

**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.

Auth: Bearer token. Permission: `media.view`.

Parameters:

| Name | 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. |

```bash
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.
