Brix Feeds API

openapi: 3.2.0
info:
  title: Brix Feeds 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: Feeds
paths:
  /v1/feeds/discover:
    get:
      operationId: getFeedDiscover
      tags:
      - Feeds
      summary: Discover feed URLs from a site
      description: Find public RSS, Atom, or JSON feed URLs published by a given site URL.
      x-brix-permission: app-instance.create
      x-brix-schema: verified
      parameters:
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: A feed URL or a web page URL.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      pageUrl:
                        type: string
                        description: The URL after redirects.
                      pageTitle:
                        anyOf:
                        - type: string
                        - type: 'null'
                        description: The page's `<title>`; null when the URL is itself a feed.
                      feeds:
                        type: array
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              description: The feed's absolute URL.
                            title:
                              type: string
                            type:
                              type: string
                              enum:
                              - rss
                              - atom
                              - json
                          required:
                          - url
                          - title
                          - type
                        description: Feeds found. Empty when the page names none.
                    required:
                    - pageUrl
                    - pageTitle
                    - feeds
                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'
        '413':
          description: The page is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`url` is missing or not a usable URL.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The site did not answer, or answered with an error.
          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.create
  /v1/feeds/fetch:
    get:
      operationId: getFeedFetch
      tags:
      - Feeds
      summary: Fetch and parse a feed
      description: 'Fetch an RSS, Atom, or JSON feed and return its articles as normalized JSON. Results are cached for five minutes.


        Needs no credential: the RSS app on the screen calls it. Limited to 120 calls a minute from one IP address.


        **Notes.**

        - `fetchedAt` is a top-level key beside `data`, not inside it.

        - Cached for 5 minutes (`Cache-Control: public, max-age=60, s-maxage=300`).'
      x-brix-schema: verified
      x-brix-notes:
      - '`fetchedAt` is a top-level key beside `data`, not inside it.'
      - 'Cached for 5 minutes (`Cache-Control: public, max-age=60, s-maxage=300`).'
      parameters:
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: The feed URL (RSS, Atom or JSON Feed). A web page URL also works when the site has a feed at a usual path (`/feed`, `/rss.xml`).
      - name: lang
        in: query
        required: false
        schema:
          type: string
        description: 'With `translate=1`: translate the article text to this language (BCP 47).'
      - name: translate
        in: query
        required: false
        schema:
          type: string
          enum:
          - '1'
      - name: dt
        in: query
        required: false
        schema:
          type: string
        description: 'With `translate=1`: the screen''s app-data token. Translation is billed to its workspace. Without a valid token the feed comes back untranslated.'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ParsedFeed'
                  fetchedAt:
                    type: string
                    description: When the feed was fetched. It is beside `data`, not in it.
                required:
                - data
                - fetchedAt
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The feed is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`url` is missing, or no feed was found at it.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: More than 120 calls in a minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The site did not answer, or answered with an error.
          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:
    ParsedFeed:
      type: object
      properties:
        source:
          type: object
          properties:
            name:
              type: string
              description: The feed's title.
            handle:
              type: string
              description: The feed URL's host.
            link:
              anyOf:
              - type: string
              - type: 'null'
              description: The site link the feed gives.
          required:
          - name
          - handle
          - link
        articles:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              description:
                type: string
                description: Plain-text summary. Can be empty.
              body:
                type: string
                description: Plain-text body; the description when the feed has only one.
              url:
                type: string
                description: The article's link.
              image:
                anyOf:
                - type: string
                - type: 'null'
              imageCredit:
                anyOf:
                - type: string
                - type: 'null'
              author:
                type: string
                description: Empty when the feed names no author.
              publishedAt:
                type: string
                description: A relative phrase made at fetch time (`2 hours ago`, `Yesterday`).
              publishedIso:
                anyOf:
                - type: string
                  description: ISO-8601 timestamp (UTC).
                - type: 'null'
                description: The publish time, or null when the feed gives no date that can be read.
              readTime:
                type: string
                description: Reading-time estimate (`1 min read`).
              category:
                type: string
                description: The first category, or empty.
            required:
            - id
            - title
            - description
            - body
            - url
            - image
            - imageCredit
            - author
            - publishedAt
            - publishedIso
            - readTime
            - category
      required:
      - source
      - articles
    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.