For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

Reference material for developers and system integrators working with myCoreAI programmatically — connecting a building, exchanging data with the Myrspoven cloud, or building tooling on top of an existing integration.

The section has two parts: a narrative page that explains which integration surface applies to a building and how it behaves, and the OpenAPI reference that documents the first-party Myrspoven AI-API endpoint by endpoint.

Integrators: start with Getting started with system integration in the Integrations chapter — it explains how the edge, the Myrspoven cloud, and myCoreAI fit together before any endpoint detail becomes useful.

Tooling developers: the Myrspoven AI-API exposes data and setpoint exchange over HTTP. The OpenAPI reference is authoritative for endpoints, request/response schemas, and authentication.

Contents

Myrspoven AI-API

Explains the surfaces myCoreAI integrates over: the first-party Myrspoven HTTP API, the Myrspoven edge for on-premise BMS connectivity, and third-party BMS/SCADA vendor APIs. Covers authentication, environments, error handling, and rate limits.

OpenAPI reference

The machine-readable specification for the first-party Myrspoven AI-API — endpoints, parameters, schemas, and authentication. This is the authoritative source for endpoint-level detail; the narrative page provides the surrounding context.

Out of scope

  • BMS and vendor setup (Schneider, Siemens, Web Port, etc.) lives in the Integrations chapter.

  • Operational runbooks — VPN credentials, server hardening, deployment procedures — are not public and are handled directly with Myrspoven.

  • Internal tooling and pipelines — Myrspoven's own build, test, and deploy process — is out of scope for partner documentation.

Conventions

  • Times are ISO 8601 in UTC unless stated otherwise.

  • "The Myrspoven cloud" refers to the hosted backend; "the edge" refers to the on-premise component; "myCoreAI" refers to the AI agent running in the cloud.

  • Credentials in examples are placeholders. Working credentials are shared through a secure channel during integration.

  • For third-party APIs, vendor docs win for endpoint-level detail where they disagree with these pages.

Getting help

Report errors or gaps to Myrspoven.

Last updated

Was this helpful?