Brix Me API

openapi: 3.2.0
info:
  title: Brix Me 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: Me
paths:
  /v1/me:
    get:
      operationId: getMe
      tags:
      - Me
      summary: Describe the calling credential
      description: 'Returns who is calling and what they are allowed to do: whether the caller is a signed-in person, an API key, or Brix support; the location an API key is pinned to, if any; the workspace; and the caller''s full set of permissions.


        Who is calling (API key, user, or Brix support), which workspace the call resolves to, and the permissions held. Call it first when a request is refused: `actor.nodeId` shows a key pinned to one location.'
      x-brix-permission: screen.view
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      actor:
                        $ref: '#/components/schemas/Actor'
                      workspace:
                        $ref: '#/components/schemas/WorkspaceRef'
                      permissions:
                        anyOf:
                        - type: string
                          const: all
                        - type: array
                          items:
                            type: string
                        description: '`all` for an owner-style credential, else every `resource.verb` held anywhere in the workspace. A planning hint: node-scoped checks still run on each call.'
                      paymentRequired:
                        anyOf:
                        - type: object
                          properties:
                            spaceId:
                              type: string
                              description: The location (child workspace) that waits for its payment.
                            spaceName:
                              type: string
                            canPay:
                              type: boolean
                              description: True when this person can add the card (`billing.edit` at that location).
                          required:
                          - spaceId
                          - spaceName
                          - canPay
                        - type: 'null'
                        description: 'Set when every seat this person holds is in a location that pays before it goes live and has not paid yet: they can read, and add a card with `POST /v1/org-nodes/{id}/payment/checkout`; every other write answers 402 `payment_required`. Null otherwise.'
                    required:
                    - actor
                    - workspace
                    - permissions
                    - paymentRequired
                required:
                - data
              example:
                data:
                  actor:
                    kind: key
                    id: key_6f7a8b9c0d1e2f3a
                    name: Menu board sync
                    nodeId: null
                  workspace:
                    id: space_1a2b3c4d5e6f7a8b
                    name: Riverside Coffee
                  permissions:
                  - screen.view
                  - screen.cast
                  - media.view
                  - media.create
                  paymentRequired: null
        '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:
        - screen.view
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.
    WorkspaceRef:
      type: object
      properties:
        id:
          type: string
          description: Workspace id.
        name:
          anyOf:
          - type: string
          - type: 'null'
          description: Workspace name; null only if the workspace row is missing.
      required:
      - id
      - name
    Actor:
      oneOf:
      - type: object
        properties:
          kind:
            type: string
            const: key
          id:
            anyOf:
            - type: string
            - type: 'null'
            description: API key id.
          name:
            anyOf:
            - type: string
            - type: 'null'
            description: The key's name.
          nodeId:
            anyOf:
            - type: string
            - type: 'null'
            description: The location the key is pinned to; null = workspace-wide. A pinned key cannot see or create outside that subtree.
        required:
        - kind
        - id
        - name
        - nodeId
      - type: object
        properties:
          kind:
            type: string
            const: user
          id:
            anyOf:
            - type: string
            - type: 'null'
          name:
            anyOf:
            - type: string
            - type: 'null'
          email:
            anyOf:
            - type: string
            - type: 'null'
          nodeId:
            type: 'null'
        required:
        - kind
        - id
        - name
        - email
        - nodeId
      - type: object
        properties:
          kind:
            type: string
            const: staff
          id:
            type: string
            description: '`staff:<email>` — Brix support opened the workspace as the customer.'
          name:
            type: string
            const: Brix staff
          email:
            type: string
          nodeId:
            type: 'null'
        required:
        - kind
        - id
        - name
        - email
        - nodeId
      description: 'The credential making the call: an API key, a user session, or Brix support.'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.