Get started
What you can build with the Relynk Builder API, what you need, and the steps to your first app.
The Relynk Builder API lets an app read your building data in Relynk, with the access of the person who signs in.
What you can build
- A dashboard of room temperatures, CO2 or humidity in a building.
- Charts of a sensor over a day, a week or a year.
- An overview of energy, water and waste use per building and month, with cost.
- A list of the rooms, equipment and sensors in a building.
The API only reads data. It never changes anything in Relynk.
What you need
- A Relynk account with access to the buildings the app should show. The app sees exactly what this account may see, nothing more.
- The connection details from Relynk: for an app builder such as Lovable, an OAuth client ID and client secret. Ask your Relynk contact for them.
The steps
Choose how you build
With Lovable you describe the app in plain language and Lovable writes it: follow Build an app with Lovable. With your own code, any language that can make HTTPS requests works: start with your first call.
Connect with your Relynk account
The app signs you in with your Relynk account (OAuth 2.0, the standard "Sign in with…" flow) and then calls the API on your behalf. See Authentication.
Check the connection
GET /me answers with who you are and the Relynk tenants (organisations) you can read. If it
works, the connection works.
Ask for the data
Every piece of data comes from a function, such as buildings.list or points.timeseries.
The guides show the common tasks, and the
concepts explain the data.
The API in one paragraph
The base URL is https://ai.relynk.io/builder/v1. Every function is a POST to
<base URL>/<name>/v<version> with a JSON body, for example POST /buildings.list/v1 with {},
and answers with JSON.
| Function | What it gives you |
|---|---|
buildings.list | The buildings you can see, with search |
resourceTypes.list | The kinds of things (rooms, equipment, sensors) in the tenant |
resourceTypes.relationships | How those kinds are connected in a building |
resources.list | Rooms, equipment and other resources, filtered |
resources.related | Resources connected to others, such as the rooms of a building |
points.list | Sensors and setpoints, with their latest reading |
points.timeseries | Readings over time in hourly, daily or other buckets |
points.summary | Average, minimum and maximum per sensor over a period |
points.raw | Individual readings |
meters.list | Energy, water and waste meters |
meters.topology | How a building's meters are connected |
consumption.buildings | Building consumption per carrier, as the EOS dashboard shows it |
consumption.meters | Consumption of individual meters |
The API reference documents the input and output of every function.