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-serial-templates-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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Brix Serial Templates 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: serial-templates
paths:
/v1/serial-templates:
get:
operationId: listSerialTemplates
tags:
- serial-templates
summary: List serial command templates
description: 'List saved RS232 serial command templates for your workspace, such as profiles for turning a display on or switching its input. Each template includes the exact bytes each command sends.
**Notes.**
- Not paginated. Only templates at locations where the key has `screen.view` are listed.'
x-brix-permission: screen.view
x-brix-schema: verified
x-brix-notes:
- Not paginated. Only templates at locations where the key has `screen.view` are listed.
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SerialTemplate'
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:
- screen.view
post:
operationId: createSerialTemplate
tags:
- serial-templates
summary: Create a serial command template
description: Create an RS232 command template. Provide a `name`, an optional `model`, an `items` array of commands each with `name`, `value`, `encoding` (`ascii` or `hex`), and `eol`, and an optional `nodeId`.
x-brix-permission: screen.edit
x-brix-schema: verified
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
model:
anyOf:
- type: string
- type: 'null'
nodeId:
description: Home location; null = workspace root.
anyOf:
- type: string
- type: 'null'
items:
description: The commands, at most 200. On update the list replaces the stored one.
maxItems: 200
type: array
items:
type: object
properties:
id:
description: Keep an existing command's id; omit to get a new one.
type: string
name:
type: string
value:
type: string
description: At most 512 characters, and it must give at least one byte.
encoding:
description: Default `ascii`. An unknown value is read as `ascii`.
type: string
enum:
- ascii
- hex
eol:
description: Default `none`. An unknown value is read as `none`.
type: string
enum:
- none
- cr
- lf
- crlf
required:
- name
- value
required:
- name
example:
name: Sony Bravia
model: FW-55BZ35
items:
- name: Power on
value: '*SCPOWR0000000000000001'
encoding: ascii
eol: lf
responses:
'201':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/SerialTemplate'
required:
- data
example:
data:
id: sertpl_2b3c4d5e6f7a8b9c
spaceId: space_1a2b3c4d5e6f7a8b
name: Sony Bravia
model: FW-55BZ35
nodeId: null
createdAt: '2026-09-28T09:00:00.000Z'
updatedAt: '2026-09-28T09:00:00.000Z'
items:
- id: sti_3c4d5e6f7a8b9c0d
name: Power on
value: '*SCPOWR0000000000000001'
encoding: ascii
eol: lf
hexPreview: 2A 53 43 50 4F 57 52 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 31 0A
'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'
'422':
description: '`name` is missing, `invalid_node` (the location is not in this workspace), or a command is not valid (no name, no value, too long, no bytes, a duplicate id, over 200 commands); `message` names it.'
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.edit
/v1/serial-templates/{id}:
delete:
operationId: deleteSerialTemplate
tags:
- serial-templates
summary: Delete a serial command template
description: 'Delete an RS232 command template. Commands already queued using this template are unaffected, because they carry their own fully expanded bytes rather than a reference to the template.
**Notes.**
- Answers `{ data: { ok: true } }`, not the `{ id, deleted: true }` most other deletes return. There is no restore route.'
x-brix-permission: screen.edit
x-brix-schema: verified
x-brix-notes:
- 'Answers `{ data: { ok: true } }`, not the `{ id, deleted: true }` most other deletes return. There is no restore route.'
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Serial template id.
example: sertpl_2b3c4d5e6f7a8b9c
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
ok:
type: boolean
const: true
required:
- ok
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'
'404':
description: No such serial template in this workspace.
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.edit
get:
operationId: getSerialTemplate
tags:
- serial-templates
summary: Get a serial command template
description: Get one RS232 command template, including a preview of the exact bytes each command will send to the device.
x-brix-permission: screen.view
x-brix-schema: verified
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Serial template id.
example: sertpl_2b3c4d5e6f7a8b9c
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/SerialTemplate'
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'
'404':
description: No such serial template in this workspace.
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
patch:
operationId: updateSerialTemplate
tags:
- serial-templates
summary: Update a serial command template
description: Update an RS232 command template's name, model, organization node, or list of commands. Existing command IDs are preserved, so anything referencing a specific command continues to work.
x-brix-permission: screen.edit
x-brix-schema: verified
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Serial template id.
example: sertpl_2b3c4d5e6f7a8b9c
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: Required on create. Cut to 120 characters.
type: string
model:
anyOf:
- type: string
- type: 'null'
nodeId:
description: Home location; null = workspace root.
anyOf:
- type: string
- type: 'null'
items:
description: The commands, at most 200. On update the list replaces the stored one.
maxItems: 200
type: array
items:
type: object
properties:
id:
description: Keep an existing command's id; omit to get a new one.
type: string
name:
type: string
value:
type: string
description: At most 512 characters, and it must give at least one byte.
encoding:
description: Default `ascii`. An unknown value is read as `ascii`.
type: string
enum:
- ascii
- hex
eol:
description: Default `none`. An unknown value is read as `none`.
type: string
enum:
- none
- cr
- lf
- crlf
required:
- name
- value
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/SerialTemplate'
required:
- data
'401':
description: Missing, expired or revoked bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: No `screen.edit` at the destination location.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: No such serial template in this workspace.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: An empty `name`, `invalid_node` (the destination is not in this workspace), or a command is not valid; `message` names it.
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.edit
components:
schemas:
SerialTemplate:
type: object
properties:
id:
type: string
description: Serial template id.
examples:
- sertpl_2b3c4d5e6f7a8b9c
spaceId:
type: string
name:
type: string
model:
anyOf:
- type: string
- type: 'null'
description: Free-text panel model (`Sony Bravia FW-series`).
nodeId:
anyOf:
- type: string
- type: 'null'
description: Home location; null = workspace root.
createdAt:
type: string
description: ISO-8601 timestamp (UTC).
updatedAt:
type: string
description: ISO-8601 timestamp (UTC).
items:
type: array
items:
type: object
properties:
id:
type: string
description: Command id. Kept across edits, so saved buttons that name it keep working.
name:
type: string
value:
type: string
description: 'The command: literal text (`ascii`) or hex digits (`hex`).'
encoding:
type: string
enum:
- ascii
- hex
eol:
type: string
enum:
- none
- cr
- lf
- crlf
description: Line ending added after the value.
hexPreview:
type: string
description: The exact bytes sent, as spaced hex (`2A 53 0A`).
required:
- id
- name
- value
- encoding
- eol
- hexPreview
required:
- id
- spaceId
- name
- model
- nodeId
- createdAt
- updatedAt
- items
description: A saved set of RS232 commands for one panel model.
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.