> 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/developer-reference/overview.md).

# 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.


---

# 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/developer-reference/overview.md?ask=<question>&goal=<endgoal>
```

`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.