# Brick Example Server

**Canonical:** https://apis.io/apis/brick/server/  
**Provider:** BRICK Schema — https://apis.io/providers/brick/  
**Base URL:** https://{brick-server-host}/brickapi/v1  
**Documentation:** https://github.com/BrickSchema/brick-example-server

Brick Example Server is one of 2 APIs that [BRICK Schema](https://apis.io/providers/brick/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Building Systems, Timeseries, SPARQL, Actuation, and Self-Hosted. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The Brick Example Server is the BrickSchema organisation's self-hostable HTTP contract, documented at docs.brickschema.org as "demonstrating how a Brick model can be abstracted by an HTTP API". OpenAPI 3.0.2, nineteen operations under /brickapi/v1/ covering timeseries read/write/delete, Turtle model upload, entity lookup, a relationship-filtered entity list keyed on the Brick object properties, raw SQL and raw SPARQL queries, physical actuation, Grafana dashboard provisioning, and application-token issue and revoke. Authentication is a bearer JWT with no scopes. The baseURL is TEMPLATED on purpose: BrickSchema operates no hosted instance and the harvested contract declares no servers block, so the host is supplied by whoever runs the software. The /brickapi/v1 path prefix is the provider's own and appears on every operation.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| GET | `/brickapi/v1/data/timeseries` | Get |
| POST | `/brickapi/v1/data/timeseries` | Post |
| DELETE | `/brickapi/v1/data/timeseries` | Delete |
| POST | `/brickapi/v1/entities/upload` | Uplaod a Turtle file |
| GET | `/brickapi/v1/entities/` | Get Entity By Id |
| POST | `/brickapi/v1/entities/list` | Post |
| POST | `/brickapi/v1/rawqueries/timeseries` | Post |
| POST | `/brickapi/v1/rawqueries/sparql` | Post |
| POST | `/brickapi/v1/actuation/` | Post |
| GET | `/brickapi/v1/grafana/details` | Get |
| GET | `/brickapi/v1/grafana/` | Get |
| POST | `/brickapi/v1/grafana/` | Post |
| GET | `/brickapi/v1/auth/login` | Get Login Via Google |
| GET | `/brickapi/v1/auth/is_registered` | Get Is Registered |
| GET | `/brickapi/v1/auth/logincallback` | Get Authorize |
| DELETE | `/brickapi/v1/auth/app_tokens/{app_token}` | Del Token |
| GET | `/brickapi/v1/auth/app_tokens` | Get Tokens |
| POST | `/brickapi/v1/auth/app_tokens` | Gen Token |
| GET | `/brickapi/v1/auth/register` | Post Register User |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/brick/refs/heads/main/openapi/brick-brick-server-openapi.yml
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/brick/refs/heads/main/openapi/_original/brick-brick-server-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/brick/refs/heads/main/overlays/brick-brick-server-overlay.yaml
- **SourceCode** — https://github.com/BrickSchema/brick-example-server
- **Documentation** — https://docs.brickschema.org/software/interfaces.html

## Other BRICK Schema APIs (1)

- [BRICK Ontology](https://apis.io/apis/brick/ontology/)

## Tags

Building Systems, Timeseries, SPARQL, Actuation, Self-Hosted

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/brick/server/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/brick/.