Weather API

Weather endpoints in the Brix REST API for digital signage: 1 operation (GET). Each lists its path, auth, required permission and a curl example.

View as Markdown · For AI agents: the full docs index is at /llms.txt

Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says Auth: none or Auth: no API key. The Permission line names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.

Every 4xx and 5xx response below returns this body:

FieldTypeDescription
errorstringMachine-readable code: unauthorized, forbidden, not_found, validation_error, conflict, rate_limited, internal_error, …
messagestringHuman-readable explanation. Safe to show an operator.
requestIdstringPresent on 5xx: quote it to support.

GET /v1/weather/widget

Auth: Bearer token. Permission: app-instance.view.

The design editor Weather slot reading for a place (?lat=&lng= or ?place=, ?units=c|f): Open-Meteo read on the server once per place (30 min fresh, 6 h stand-in), 202 pending while a slow first read goes on, unavailable when the provider refuses. Members with

curl "https://api.brixsignage.com/v1/weather/widget" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.