Brix Apps API

openapi: 3.2.0
info:
  title: Brix Apps 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:
- name: Apps
paths:
  /v1/apps/{key}/render:
    get:
      operationId: renderApp
      tags:
      - Apps
      summary: Render a catalog app
      description: 'Get the rendered HTML for one app from the app catalog. This is the same output used by the player and by the content management system preview.


        **Notes.**

        - HTML for an iframe, with a strict content security policy; who may frame it is limited to Brix players and the console.'
      x-brix-schema: verified
      x-brix-notes:
      - HTML for an iframe, with a strict content security policy; who may frame it is limited to Brix players and the console.
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: The app's catalog key.
        example: clock
      - name: config
        in: query
        required: false
        schema:
          type: string
        description: The app's settings as a JSON string (at most 8 KB; invalid JSON renders the defaults).
      - name: lang
        in: query
        required: false
        schema:
          type: string
        description: BCP 47 language tag for the app's text (default `en-US`).
      - name: brand
        in: query
        required: false
        schema:
          type: string
        description: A brand kit as a JSON string, for apps that follow the brand.
      - name: dt
        in: query
        required: false
        schema:
          type: string
        description: An app data token, for an app bound to a data source (`dataSourceId` in `config`).
      responses:
        '200':
          description: Success. The body is the file itself.
          content:
            text/html:
              schema:
                type: string
                format: binary
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Unknown app key. The body is still an HTML card saying so.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: '`config` is over 8 KB.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
  /v1/apps/catalog:
    get:
      operationId: listAppCatalog
      tags:
      - Apps
      summary: List the apps this workspace can add
      description: List the apps available to your workspace, including which ones are currently visible for your account to add.
      x-brix-permission: app-instance.view
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      apps:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              description: The `appKey` to create an instance with.
                            status:
                              type: string
                              enum:
                              - alpha
                              - beta
                              - ga
                              - deprecated
                            visible:
                              type: boolean
                              description: 'True when this workspace can add it: enabled and GA, or alpha/beta with early access.'
                          required:
                          - key
                          - status
                          - visible
                    required:
                    - apps
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - app-instance.view
  /v1/apps/counter/{token}:
    get:
      operationId: getAppCounter
      tags:
      - Apps
      summary: Get a live counter value
      description: 'Get the current value of a live counter app, such as Now Serving or Goal Tracker. Access is controlled by the `token` in the URL rather than by an API key; anyone with the token can read the value.


        **Notes.**

        - An unknown token answers 200 with `value: null`, not 404.'
      x-brix-schema: verified
      x-brix-notes:
      - 'An unknown token answers 200 with `value: null`, not 404.'
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
        description: The counter's control code (8–64 letters, digits, `_` or `-`), from the app's settings.
        example: ns-front-desk-01
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      value:
                        anyOf:
                        - type: integer
                        - type: 'null'
                        description: Null until the counter is first set.
                      label:
                        anyOf:
                        - type: string
                        - type: 'null'
                    required:
                    - value
                    - label
                required:
                - data
        '400':
          description: '`bad_token`: the token is not 8–64 letters, digits, `_` or `-`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
    post:
      operationId: postAppCounter
      tags:
      - Apps
      summary: Update a live counter value
      description: Set or adjust the value of a live counter app. Provide either an absolute value or a relative change, and the resulting value is clamped between 0 and 999999. Access is controlled by the `token` in the URL rather than by an API key.
      x-brix-schema: verified
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
        description: The counter's control code (8–64 letters, digits, `_` or `-`), from the app's settings.
        example: ns-front-desk-01
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  description: Set to this value.
                  type: number
                delta:
                  description: Add this (may be negative). Used when `value` is absent.
                  type: number
                label:
                  description: A new label (first 80 characters kept).
                  type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      value:
                        type: integer
                        description: The stored value, 0–999999.
                      label:
                        anyOf:
                        - type: string
                        - type: 'null'
                        description: The label SENT in this request; null when none was sent, even if one is stored.
                    required:
                    - value
                    - label
                required:
                - data
        '400':
          description: '`bad_token`, or `value_or_delta_required`: neither is a number.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`unknown_token`: no saved app uses this control code.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: More than 120 updates a minute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
  /v1/apps/counter/{token}/control:
    get:
      operationId: getAppCounterControl
      tags:
      - Apps
      summary: Get the counter control page
      description: Get an HTML page with simple controls for adjusting a live counter from a phone. The page submits its changes back to the counter endpoint. Access is controlled by the `token` in the URL.
      x-brix-schema: verified
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
        description: The counter's control code (8–64 letters, digits, `_` or `-`), from the app's settings.
        example: ns-front-desk-01
      - name: start
        in: query
        required: false
        schema:
          type: number
        description: The value shown before the first read.
      - name: label
        in: query
        required: false
        schema:
          type: string
        description: The page's heading (default `Now Serving`).
      responses:
        '200':
          description: Success. The body is the file itself.
          content:
            text/html:
              schema:
                type: string
                format: binary
        '400':
          description: The token is not 8–64 letters, digits, `_` or `-` (plain text body).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …'
        message:
          description: Human-readable explanation. Safe to show an operator.
          type: string
        requestId:
          description: 'Present on 5xx: quote it to support.'
          type: string
      required:
      - error
      additionalProperties: {}
      description: Error envelope returned by every failing request.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.