Brix

Brix Screens API

The screens API from Brix — 48 operation(s) for screens.

GitHub OpenAPI

Operations 51

GET /v1/screens List screens #
POST /v1/screens Create a screen #
DELETE /v1/screens/{id} Delete a screen #
GET /v1/screens/{id} Get a screen #
PATCH /v1/screens/{id} Update a screen's settings #
POST /v1/screens/{id}/assign Set what a screen plays #
POST /v1/screens/{id}/claim-replacement Replace a screen's device #
POST /v1/screens/{id}/commands Send a command to a screen #
GET /v1/screens/{id}/commands/{commandId} Get a command's status #
GET /v1/screens/{id}/diagnose Diagnose a screen issue #
GET /v1/screens/{id}/diagnostic-bundles List a screen's diagnostic bundles #
GET /v1/screens/{id}/diagnostic-bundles/{bundleId} Download a diagnostic bundle #
GET /v1/screens/{id}/diagnostics Get consolidated screen diagnostics #
GET /v1/screens/{id}/display-history Get a screen's display history #
GET /v1/screens/{id}/frames Get a screen's frame history #
POST /v1/screens/{id}/kiosk-recovery/reveal Reveal a screen's recovery code #
POST /v1/screens/{id}/kiosk-recovery/rotate Rotate a screen's recovery code #
POST /v1/screens/{id}/lan-secret/rotate Rotate a screen's local network key #
GET /v1/screens/{id}/live-thumbnail Get a screen's live thumbnail #
GET /v1/screens/{id}/logs Get a screen's activity log #
POST /v1/screens/{id}/mirror Start a screen mirror session #
GET /v1/screens/{id}/outages Get a screen's outage history #
GET /v1/screens/{id}/playback-quality Get a screen's playback quality #
GET /v1/screens/{id}/preview Preview what a screen would play #
GET /v1/screens/{id}/quality Get a screen's playback and device quality #
POST /v1/screens/{id}/replace-device Unpair a screen's device #
GET /v1/screens/{id}/resource-pressure Get a screen's resource pressure #
POST /v1/screens/{id}/restore Restore a deleted screen #
POST /v1/screens/{id}/revoke-device Revoke a screen's device access #
POST /v1/screens/{id}/rotate-token Rotate a screen's device token #
GET /v1/screens/{id}/state Get a screen's reported device state #
GET /v1/screens/{id}/telemetry Get a screen's raw telemetry #
POST /v1/screens/{id}/trigger Trigger a screen interaction #
POST /v1/screens/{id}/unpower-and-delete Power off and delete a screen #
GET /v1/screens/{id}/up-next Get a screen's up-next schedule #
GET /v1/screens/{id}/why Explain what a screen shows and why #
POST /v1/screens/bulk-assign Set what many screens play #
POST /v1/screens/bulk-settings Apply settings to many screens #
POST /v1/screens/claim Pair a device by its code #
POST /v1/screens/commands Send a command to many screens #
GET /v1/screens/count-by-status Count screens by status #
POST /v1/screens/enroll Enroll a screen programmatically #
POST /v1/screens/heavy-check Check if content is too heavy for screens #
GET /v1/screens/pair-cost Price one more screen #
GET /v1/screens/pending List pending discovered devices #
POST /v1/screens/pending/{id}/dismiss Dismiss a pending device #
POST /v1/screens/pending/{id}/identify Identify a pending device #
POST /v1/screens/pending/claim Claim multiple discovered devices #
POST /v1/screens/pending/identify-all Identify all pending devices #
GET /v1/screens/recycle-bin List deleted screens #
GET /v1/screens/touch-content Which of the named content refs (creative:/layout:/playlist:) carry tap… #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/brixsignage-com/openapi/brixsignage-com-screens-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-screen-schema.json
📊
JSONSchema
https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-schema.json
📊
JSONSchema
https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-manifest-preview-schema.json
📊
JSONSchema
https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-updated-schema.json
📊
JSONSchema
https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-workspace-prefs-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/brixsignage-com:brixsignage-com-screens-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

brixsignage-com-screens-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Brix Screens API
  version: '1'
  summary: 'Control plane for Brix digital signage: screens, content, playlists, schedules, casts and emergencies.'
  description: 'Generated from the route table the API actually mounts

    (`apps/api/routes.snapshot.json`), the description each route is required to

    carry (`tests/contracts/route-registry.json`), and request/response schemas

    (`apps/api/src/openapi/`). CI enforces all three, so this document cannot list a

    route that does not exist or omit one that does.


    **Schemas.** 447 operations carry request and response schemas

    (`x-brix-schema: verified`). Each is checked in CI against the response the

    real handler returns — a missing, mistyped or undeclared field fails the build.

    The remaining operations are route-level only (`x-brix-schema: none`): their

    path, method, permission and purpose are exact, but the shape of `data` is not

    yet modelled, and we would rather say so than publish a schema that validates

    against nothing. Objects are open: a new field is not a breaking change.


    **Envelope.** Success bodies are `{ "data": … }`. Failures are

    `{ "error": "", "message": "…" }`, plus `requestId` on a 5xx.

    Many list routes page opt-in (see each operation): pass `?limit=` and

    follow `nextCursor` via `?cursor=` until it is null.


    **Authentication.** `Authorization: Bearer ` with an API key

    (`ak_…`, created in the console under Settings → API & MCP) or a user session. An

    API key carries a creator-chosen set of `resource.verb` permissions and may be

    pinned to one location''s subtree; a key can never be granted a permission its

    creator does not hold. The permission an operation needs is in

    `x-brix-permission` and in its security requirement.


    **Tenancy.** Every request resolves to one workspace. A resource belonging to

    another tenant returns 404, never 403, so a response never confirms that an

    account exists.


    **Rate limits.** A 429 carries `Retry-After`; a 503 `database_busy` means retry

    after the `Retry-After` interval.'
servers:
- url: https://api.brixsignage.com
  description: Production
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (255 KB total) ---
# Full source: https://artifacts.apis.io/brixsignage-com/openapi/brixsignage-com-screens-api-openapi.yml