Developer documentation

Build on BIMRelay

Connect your scripts, applications and AI assistants to BIMRelay. Read selected projects and COBie 2.4 workbooks through a REST API or an MCP server, with access limited to the projects and permissions you approve.

Make your first API request Connect an AI assistant

RequestcURL

curl --fail-with-body \
  'https://api.bimrelay.com/api/v1/projects?limit=20' \
  -H "Authorization: Bearer $BIMRELAY_API_TOKEN"

Response · 200 OKJSON

{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "workspace_id": "00000000-0000-4000-8000-000000000002",
      "name": "Example project",
      "status": "active",
      "description": "Facilities handover for the civic center.",
      "classification_system": "omniclass"
    }
  ],
  "next_cursor": null
}

BIMRelay REST API

Standard HTTPS requests and JSON responses for scripts, data pipelines and connected applications. Authenticate with a personal API token or OAuth, and use the OpenAPI contract to generate a client.

21 endpoints · OpenAPI 3.1

BIMRelay MCP server

Model Context Protocol tools for compatible AI assistants. Search workbook rows, summarize Issues and Asset review recommendations in natural language.

21 tools · Streamable HTTP

What you can read

Projects you have approved for the connection
Current workbook sheets, standard columns and custom columns
Sheet and column keys for every COBie 2.4 worksheet, and the rows in each sheet
Project descriptions and classification systems
Existing validation Issues and Asset review findings
Existing Excel exports and temporary download links for completed files

Both interfaces default to read access. Separate write permissions enable cell editing, manual-row management and generated-row exclusions; settings, memberships, extraction, reviews and export creation remain unavailable.

Access and security

Each connection is limited to the projects you select and to permissions you choose, and every request is checked against your current BIMRelay membership. Personal tokens expire after 7, 30 or 90 days and can be revoked at any time, and connected apps use OAuth with PKCE. The full request and response contract is published as an OpenAPI 3.1 document. Read more about BIMRelay security.