Developer portal

Build against evidence, not implied authority.

Heliox OS exposes a versioned, read-only metadata API and a documentation MCP server for agents and developers. Neither surface can reach a user's local daemon, credentials, files, or computer-control actions.

No API key requiredRead-only public dataOpenAPI 3.1MCP Streamable HTTP

Live read-only sandbox

Quickstart

No API key is required or issued. Start with GET /api/v1/status, then inspect capabilities and releases. The complete function-compatible contract is openapi.json.

curl -sS https://www.helioxos.dev/api/v1/status
curl -sS https://www.helioxos.dev/capabilities.json
curl -sS https://www.helioxos.dev/releases.json

Public API surface

GET /api/v1/status - version and discovery
GET /capabilities.json - generated action metadata
GET /releases.json - public releases
POST /api/mcp - read-only documentation tools

Authentication and authority

Public metadata requires no API key. Heliox does not issue a public computer-control credential. Provider keys and local RPC identities stay inside the installed desktop application and its approval pipeline.

Typed errors

HTTP API failures use RFC 9457 application/problem+json with a stable code and resolution hint. MCP request errors retain their JSON-RPC envelope and add machine-readable error data.

Versioning and deprecation

Function APIs use URL-major versions beginning at /api/v1/. Breaking changes move to a new major path. Deprecations receive at least 90 days' notice when practical through RFC 9745 Deprecation, Sunset, and migration Link headers. Static catalogs carry schema versions; MCP negotiates its protocol version.

Rate limits

Dynamic public endpoints enforce 120 requests per 60 seconds per client and runtime instance. Responses include RateLimit-Policy, RateLimit, compatibility fields, and Retry-After on HTTP 429. Prefer the cacheable static catalogs over polling.

Documentation MCP

The stable protocol is 2025-11-25. Send JSON-RPC with POST and advertise both JSON and SSE in Accept. The stateless server returns JSON responses and intentionally answers standalone GET stream requests with HTTP 405.

Publication boundary

Local CLI and package status

The source package declares pilot-daemon, pilot-neurod, and heliox-mcp console commands after source installation. This page does not claim a registry distribution on npm, PyPI, or Homebrew until one is independently published and verified.

python -m pip install "git+https://github.com/VyomKulshrestha/Heliox-OS.git#subdirectory=daemon"
heliox-mcp --help
pilot-daemon --help