> 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/myrspoven-docs/docs-us-cs/vyvojarska-reference/myrspoven-ai-api.md).

# Myrspoven AI-API

myCoreAI si s každou budovou vyměňuje data a žádané hodnoty přes jedno z několika rozhraní — vlastní Myrspoven AI-API, API dodavatele třetí strany pro BMS/SCADA nebo Myrspoven edge běžící on-premise. Tato stránka popisuje každé rozhraní a odkazuje na dokumentaci dodavatele tam, kde API vlastní třetí strana.

Pro konceptuální model toku dat viz [Přehled integrací](/myrspoven-docs/docs-us-cs/integrace/overview.md).

## Dostupná API rozhraní

### Myrspoven AI-API (vlastní)

Cloud Myrspoven zpřístupňuje vlastní HTTP API pro výměnu dat o budově s myCoreAI — čtení aktuálních hodnot a žádaných hodnot, vyhledávání signálů, zápis žádaných hodnot a nahrávání dat signálů. Konektor na straně budovy se integruje voláním tohoto API; například SmartConnector běžící v Schneider EcoStruxure Building Operation (EBO) jej používá ke čtení optimalizovaných žádaných hodnot a odesílání hodnot z budovy zpět.

API je zdokumentováno v **referenční dokumentaci OpenAPI** v této části, která je závazným zdrojem pro endpointy, schémata požadavků/odpovědí a ověřování.

### API třetích stran pro BMS/SCADA

Některé platformy BMS a SCADA zpřístupňují vlastní HTTP nebo API dodavatele — například Siemens Building X a Web Port. Tam, kde se používá jedno z nich, se myCoreAI integruje přes toto API, aby mohl vyhledávat body, číst hodnoty v reálném čase i historické hodnoty a zapisovat žádané hodnoty. Rozhraní API — endpointy, schémata, formáty parametrů — vlastní dodavatel a **dokumentace dodavatele je závazným zdrojem**. Rozsah integrace, přihlašovací údaje a aktivace se s Myrspoven sjednávají během onboardingu.

### Myrspoven edge (on-premise)

Kde není možné se připojit přes konektor nebo dostupné API dodavatele, Myrspoven edge běží v prostředí vlastníka budovy, připojuje se k BMS lokálně a vyměňuje si data s cloudem Myrspoven. Edge komunikuje pouze směrem ven — stahuje žádané hodnoty a úlohy, které potřebuje, a odesílá hodnoty a výsledky zpět — takže na straně budovy nejsou potřeba žádné příchozí otevřené porty firewallu.

## Ověřování a přihlašovací údaje

Myrspoven AI-API používá tokeny bearer OAuth2. ID klienta a tajný klíč vydává Myrspoven a předávají se zabezpečeným kanálem — nikdy e-mailem ani přes chat. Referenční dokumentace OpenAPI popisuje tok tokenů.

Tam, kde API třetí strany vyžaduje ověřování (typicky servisní účet pro zápis), přihlašovací údaje se vytvářejí na straně dodavatele a sdílejí se s Myrspoven přes zabezpečený kanál. Některé platformy dodavatelů umožňují přístup jen pro čtení bez ověřování; to je nastavení daného dodavatele. Zápisy vždy vyžadují dedikovaný servisní účet.

Požadované scope a oprávnění určuje Myrspoven pro každou integraci během onboardingu.

## Prostředí

Integrace se konfigurují pro každou budovu vůči jedinému produkčnímu prostředí. Změny, které by mohly ovlivnit provozní budovu, se koordinují s Myrspoven a bezpečný způsob testování je pozastavit zápisy pro testovanou budovu.

## Zpracování chyb

U vlastní Myrspoven AI-API jsou kódy odpovědí a schémata chyb zdokumentovány v referenční dokumentaci OpenAPI. U rozhraní třetích stran se zpracování chyb řídí konvencemi dodavatele, který dané rozhraní vlastní. Když se myCoreAI nedokáže připojit k BMS, přestane zapisovat žádané hodnoty a BMS pokračuje v provozu podle své vlastní logiky — budova zůstává v běžném provozu; pouze optimalizace se pozastaví, dokud se spojení neobnoví.

## Omezení četnosti

Frekvence čtení a zápisů se sjednává pro každou budovu během spuštění. Stejný plán platí i tehdy, když se budova připojuje přes Myrspoven edge; edge přebírá splatné úlohy z cloudu Myrspoven a neudržuje si vlastní intervaly. Čtení běží ve výchozím nastavení každých 15 minut u většiny integrací a každých 12 minut u Web Port. Zápisy žádaných hodnot probíhají každých 15 minut a postupně procházejí nejnovější výstup optimalizace. Kde dodavatel třetí strany uplatňuje vlastní limity četnosti, jsou zdokumentovány dodavatelem a doladěny ve spolupráci s Myrspoven.

## Získání pomoci

S integracemi nad rámec rozhraní popsaných zde kontaktujte přímo 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 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/myrspoven-docs/docs-us-cs/vyvojarska-reference/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.
