> For the complete documentation index, see [llms.txt](https://docs.myrspoven.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.myrspoven.com/integrations/api.md). # API Most buildings connect to myCoreAI through their Building Management System (BMS) or the Myrspoven edge. Some sites instead expose data — energy meters, indoor climate sensors, occupancy systems — through a vendor API. This page orients on when an API integration applies, its shape, and where the full reference lives. ## When an API integration applies myCoreAI uses an API integration when: * Energy data comes from a third-party platform (for example **Mestro** or **Metry**) rather than the BMS. * Indoor climate sensors are owned by a third-party platform that exposes a cloud API. * The BMS itself exposes a network-reachable REST API, OPC UA endpoint, or vendor SDK that myCoreAI can read from and write to directly. Bringing meters or sensors onto the BMS is the simpler path when possible — fewer moving parts, no third-party provider cost, one connection to maintain. An API integration is the right choice when the data only lives outside the BMS, or when the BMS itself is the API. ## Shape of an API integration All three cases share the same shape: Myrspoven holds credentials to read from (and where relevant, write to) the vendor's API on an agreed schedule. Once ingested, the signals are treated identically to BMS signals — myCoreAI's model and the myPortal dashboards are transport-agnostic. The customer-provided inputs are also consistent across vendors: * An account or API key with read access, and write access where myCoreAI must push setpoints back. * A confirmed mapping of meter IDs, sensor IDs, or signals to buildings and zones. * A technical point of contact for commissioning. Exact credentials, endpoints, and ID formats are vendor-specific and documented per building during the technical survey. ## Cost Third-party platforms typically charge for API access under their own contract. Myrspoven does not charge separately for the integration. Adding a vendor connector that isn't already supported is evaluated case by case — request one via Myrspoven. ## Security API credentials are stored in Myrspoven's cloud and used only for the agreed integration. Scope never widens beyond the configured read/write signals. See [Security](/trust-and-security/overview.md). ## Related * BMS — direct BMS connections, including REST / OPC UA / BACnet shapes. * Energy data — Mestro, Metry, and manual upload. * Indoor climate — third-party sensor-vendor API integrations. * Full API reference — see the [Developer reference](/developer-reference/myrspoven-ai-api.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.myrspoven.com/integrations/api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.