HEART API Standard#
Track: Every track: the list of files. New here? Read Start Here first.
Default port: HEART 43278, fallback 7685. Run one HEART Gateway per host and address systems as heart://server:43278/systems/{name}.
| Path | What it is |
|---|---|
HEART-Standards-Family.md | Start here. Plain-language map of the nine-part standard now being organised. |
HEART-Part-1-Basics-1.0.md | Part 1: what HEART is, and the meaning of every word. Read first. |
HEART-Part-2-Autonomy-Levels-1.0.md | Part 2: Autonomy Levels A0 to A5, how much a system does on its own. |
HEART-Part-3-Information-Model-1.0.md | Part 3: the seven messages, shared word lists, fault codes, Feature Sets and modules. |
HEART-Part-4-Connections-1.0.md | Part 4: ports, HTTP, logins, encryption and identity, the Gateway, sockets, MQTT and serial lines. |
HEART-Part-6-Human-Control-and-Safety-1.0.md | Part 6: the approval gate, proof of presence, the stop control, AI rules, model changes, fleets, physical safety and the threat list. |
HEART-Part-9-Testing-and-Certification-1.0.md | Part 9: how to test a product, publish a Declaration and, later, get certified. |
HEART-Signal-Tables-1.0.md | Signal tables (signals.json): every signal declared once and checked by a person, and the generator that drafts them. |
HEART-Monitor-1.0.md | HEART Hub: owners register a device with its claim code and watch its health at heartcortex.ai/device/<ID>, or on their own site. Code in heart-monitor/. |
HEART-Security-Advisory-2026-001.md | Five critical and one high-severity flaw found and fixed on 8 November 2026, in plain language. |
HEART-API-Standard-1.0.md | The current API standard. Its text is moving into Parts 1 to 9. Where a drafted part disagrees with it, the part prevails. |
HEART-Core-Standard-1.0.md | The embedded AI that understands and serves the API. It will become Part 7. |
openapi/heart-api-1.0.yaml | HTTP contract (OpenAPI 3.1). |
schemas/1.0/ | Message and request schemas (JSON Schema 2020-12). x-heart-privacy carries each field's privacy level. |
examples/ | One valid example per message and request, based on Pitch Lab. Names and hosts are illustrative. |
examples/custom/ | 15 custom definitions mapping uncommon commands to 13 native protocols. |
core/ | API Index, C embedding header and understanding test cases. |
tools/validate.py | Checks the schemas, examples, OpenAPI paths, API Index and the privacy and injection rules against each other. |
tools/build_index.py | Rebuilds the API Index from the OpenAPI file. |
tools/recall_check.py | Scores the no-model Recall tier on the test cases. |
Validate#
python3 -m venv .venv
.venv/bin/pip install 'jsonschema[format]' pyyaml
.venv/bin/python tools/validate.py
npx @redocly/cli lint openapi/heart-api-1.0.yaml