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-creative-overrides-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 Creative Overrides 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: creative-overrides
paths:
/v1/creative-overrides/{creativeId}:
get:
operationId: getCreativeOverride
tags:
- creative-overrides
summary: Get a creative's overrides at a location
description: Return the edits a location has made to a creative that was shared with it, the merged result of applying those edits, and any edits that have stopped applying.
x-brix-permission: creative.view
x-brix-schema: verified
parameters:
- name: creativeId
in: path
required: true
schema:
type: string
description: 'Creative id: one of yours, or one shared into this workspace.'
example: cr_4d5e6f7a8b9c0d1e
- name: node
in: query
required: false
schema:
type: string
description: 'Location id. Default: the workspace root.'
- name: view
in: query
required: false
schema:
type: string
enum:
- values
description: '`values`: leave out `creative` and `base` (the two full designs) and add `editable`. For setting prices from a script or an AI tool.'
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
creativeId:
type: string
nodeId:
type: string
description: The location the edits apply at.
values:
type: object
propertyNames:
type: string
additionalProperties:
type: object
propertyNames:
type: string
additionalProperties: {}
description: 'The location''s edits: box id → the box fields it changes (for example `{ "price": { "text": "13.00" } }`).'
overrideId:
anyOf:
- type: string
- type: 'null'
description: Id of the stored edits (what an approval request is opened against); null before the first save.
approvalState:
type: string
enum:
- draft
- pending
- approved
- rejected
description: Review state of the edits (not of the design).
requiresApproval:
type: boolean
description: The location requires approval before the edits air.
skipsApproval:
type: boolean
description: The author waived that review for this design.
creative:
description: 'The design with the edits applied: what the screens play. Absent with view=values.'
$ref: '#/components/schemas/OverrideCreative'
orphanedBoxIds:
type: array
items:
type: string
description: Edited box ids the design no longer has.
sharedFrom:
anyOf:
- type: string
- type: 'null'
description: The workspace that owns the design, when it was shared in from another workspace.
base:
description: The design without the edits. Absent with view=values.
$ref: '#/components/schemas/OverrideCreative'
editable:
description: 'With view=values: every text box the author left editable, with the text it shows now.'
type: array
items:
type: object
properties:
boxId:
type: string
name:
anyOf:
- type: string
- type: 'null'
text:
type: string
required:
- boxId
- name
- text
rejectedFields:
type: array
items:
type: string
description: '`boxId.field` edits that no longer apply because the author locked the field.'
updatedAt:
anyOf:
- type: string
description: ISO-8601 timestamp (UTC).
- type: 'null'
description: When the edits were last saved; null before the first save.
required:
- creativeId
- nodeId
- values
- overrideId
- approvalState
- requiresApproval
- skipsApproval
- orphanedBoxIds
- sharedFrom
- rejectedFields
- updatedAt
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: Unknown location, no such creative, or the creative is not usable at that location.
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:
- creative.view
patch:
operationId: mergeCreativeOverride
tags:
- creative-overrides
summary: Change some of a creative's overrides at a location
description: 'Change only the edits you name on a creative shared with a location, keeping every other edit. Send null for a box to remove its edits. Fields the creative''s author locked are rejected with a 422 error.
**Notes.**
- Use this to set one price without resending the others. `values` in the response is every stored edit after the change. A save returns approved edits to `draft`.'
x-brix-permission: creative.edit
x-brix-schema: verified
x-brix-notes:
- Use this to set one price without resending the others. `values` in the response is every stored edit after the change. A save returns approved edits to `draft`.
parameters:
- name: creativeId
in: path
required: true
schema:
type: string
description: 'Creative id: one of yours, or one shared into this workspace.'
example: cr_4d5e6f7a8b9c0d1e
- name: node
in: query
required: false
schema:
type: string
description: 'Location id. Default: the workspace root.'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
values:
type: object
propertyNames:
type: string
additionalProperties:
anyOf:
- type: object
propertyNames:
type: string
additionalProperties: {}
- type: 'null'
description: Only the boxes to change, keyed by box id. A box's fields are layered over its stored edits; null removes that box's edits. Boxes left out keep their edits.
required:
- values
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
creativeId:
type: string
nodeId:
type: string
description: The location the edits apply at.
values:
type: object
propertyNames:
type: string
additionalProperties:
type: object
propertyNames:
type: string
additionalProperties: {}
description: 'The location''s edits: box id → the box fields it changes (for example `{ "price": { "text": "13.00" } }`).'
overrideId:
anyOf:
- type: string
- type: 'null'
description: Id of the stored edits (what an approval request is opened against); null before the first save.
approvalState:
type: string
enum:
- draft
- pending
- approved
- rejected
description: Review state of the edits (not of the design).
requiresApproval:
type: boolean
description: The location requires approval before the edits air.
skipsApproval:
type: boolean
description: The author waived that review for this design.
creative:
description: 'The design with the edits applied: what the screens play.'
$ref: '#/components/schemas/OverrideCreative'
orphanedBoxIds:
type: array
items:
type: string
description: Edited box ids the design no longer has.
updatedAt:
type: string
description: ISO-8601 timestamp (UTC).
required:
- creativeId
- nodeId
- values
- overrideId
- approvalState
- requiresApproval
- skipsApproval
- creative
- orphanedBoxIds
- updatedAt
required:
- data
'401':
description: Missing, expired or revoked bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: You lack creative.edit at that location.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unknown location, no such creative, or the creative is not usable at that location.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: '`validation_error` (bad `values`, more than 300 boxes in total, unknown box ids in `unknownBoxes`) or `locked` (fields the author locked, in `violations`).'
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:
- creative.edit
put:
operationId: replaceCreativeOverride
tags:
- creative-overrides
summary: Replace a creative's overrides at a location
description: 'Replace a location''s edits to a shared creative. If the creative''s author has locked a field against editing, the request is rejected with a 422 error for that field.
**Notes.**
- The response has no `sharedFrom`, `base` or `rejectedFields` (GET has them). A save returns approved edits to `draft`.'
x-brix-permission: creative.edit
x-brix-schema: verified
x-brix-notes:
- The response has no `sharedFrom`, `base` or `rejectedFields` (GET has them). A save returns approved edits to `draft`.
parameters:
- name: creativeId
in: path
required: true
schema:
type: string
description: 'Creative id: one of yours, or one shared into this workspace.'
example: cr_4d5e6f7a8b9c0d1e
- name: node
in: query
required: false
schema:
type: string
description: 'Location id. Default: the workspace root.'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
values:
type: object
propertyNames:
type: string
additionalProperties:
type: object
propertyNames:
type: string
additionalProperties: {}
description: Every edit to keep, at most 300 boxes. Edits left out are removed.
required:
- values
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
creativeId:
type: string
nodeId:
type: string
description: The location the edits apply at.
values:
type: object
propertyNames:
type: string
additionalProperties:
type: object
propertyNames:
type: string
additionalProperties: {}
description: 'The location''s edits: box id → the box fields it changes (for example `{ "price": { "text": "13.00" } }`).'
overrideId:
anyOf:
- type: string
- type: 'null'
description: Id of the stored edits (what an approval request is opened against); null before the first save.
approvalState:
type: string
enum:
- draft
- pending
- approved
- rejected
description: Review state of the edits (not of the design).
requiresApproval:
type: boolean
description: The location requires approval before the edits air.
skipsApproval:
type: boolean
description: The author waived that review for this design.
creative:
description: 'The design with the edits applied: what the screens play.'
$ref: '#/components/schemas/OverrideCreative'
orphanedBoxIds:
type: array
items:
type: string
description: Edited box ids the design no longer has.
updatedAt:
type: string
description: ISO-8601 timestamp (UTC).
required:
- creativeId
- nodeId
- values
- overrideId
- approvalState
- requiresApproval
- skipsApproval
- creative
- orphanedBoxIds
- updatedAt
required:
- data
'401':
description: Missing, expired or revoked bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: You lack creative.edit at that location.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Unknown location, no such creative, or the creative is not usable at that location.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: '`validation_error` (bad `values`, more than 300 boxes, unknown box ids in `unknownBoxes`) or `locked` (fields the author locked, in `violations`).'
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:
- creative.edit
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.
OverrideCreative:
type: object
properties:
id:
type: string
nodeId:
anyOf:
- type: string
- type: 'null'
name:
type: string
backgroundUrl:
anyOf:
- type: string
- type: 'null'
boxes:
type: array
items:
type: object
propertyNames:
type: string
additionalProperties: {}
scenes:
type: array
items:
type: object
propertyNames:
type: string
additionalProperties: {}
dataSourceId:
anyOf:
- type: string
- type: 'null'
stage:
description: Absent when not set.
type: string
shareLockDefault:
anyOf:
- {}
- type: 'null'
shareEditsSkipApproval:
type: boolean
stageWidth:
type: integer
stageHeight:
type: integer
touchEnabled:
type: boolean
approvalState:
type: string
enum:
- draft
- pending
- approved
- rejected
description: Review state. Editing an approved row returns it to `draft`.
updatedAt:
type: string
description: ISO-8601 timestamp (UTC).
required:
- id
- nodeId
- name
- backgroundUrl
- boxes
- scenes
- dataSourceId
- shareLockDefault
- shareEditsSkipApproval
- approvalState
- updatedAt
description: 'A creative''s design: the boxes and scenes with their settings.'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.