> 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/developers/myrspoven-ai-api.md).

# Myrspoven AI-API

The Myrspoven AI-API is the HTTP API a connector on the building side uses to exchange data with myCoreAI. The connector sends the building's values to the Myrspoven cloud and fetches the optimized setpoints to write. The SmartConnector in Schneider EcoStruxure Building Operation (EBO) works this way.

## Who it is for

Partners who build or operate a BMS connector, by agreement with Myrspoven.

It is not a general data API. To read the status of your buildings into your own system, use the [Reports API](https://docs.myrspoven.com/developers/reports-api.md).

Most buildings connect without it, through a BMS integration or the Myrspoven edge. See [How integrations work](https://docs.myrspoven.com/connect-your-building/overview).

## Access and authentication

* **Tokens:** the API uses OAuth2 bearer tokens. Myrspoven issues a client ID and secret and shares them through a secure channel, never over email or chat.
* **Buildings:** credentials are tied to your company and only reach its buildings.
* **Read and write:** access is not split into read and write. The same credentials that read values can also change settings, for example switch AI control on or off for a building, or change a signal's minimum and maximum. Store and share them accordingly.

## Endpoint reference

The pages under this one list the endpoints and their request bodies, generated from the API itself. They do not describe authentication or error responses. Your Myrspoven contact covers those during the integration.

## Getting help

Contact Myrspoven for access or with integration questions.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.myrspoven.com/developers/myrspoven-ai-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
