RelynkLearn
Builder APIGuides

Your first call

Check the connection with GET /me and list your buildings, with curl or JavaScript.

Check that your sign-in works, then list the buildings you can see.

You need an access token from a signed-in Relynk user (see Authentication). Below, $TOKEN stands for it.

Check the connection

curl -s https://ai.relynk.io/builder/v1/me \
  -H "authorization: Bearer $TOKEN"

You get back who you are and the tenants you can read:

Response
{
	"userId": "6f1c…",
	"tenants": [{ "id": "8a1f…", "name": "Example Property AS" }]
}

With one tenant, later calls need no tenantId. With several, see Choose a tenant.

List your buildings

curl -s -X POST https://ai.relynk.io/builder/v1/buildings.list/v1 \
  -H "authorization: Bearer $TOKEN" \
  -H 'content-type: application/json' \
  -d '{}'
Response
{
	"buildings": [{ "id": "3c0d…", "name": "Storgata 1" }],
	"hasMore": false
}

The other guides use the same relynk(path, input) helper. Each building's id is what other functions take as buildingId or buildingIds.

On this page