Skip to main content

API Reference

HeliOS publishes machine-readable specs and human-readable guides for each API surface.

Specs (Machine-Readable)

  • OpenAPI (HTTP): GET /openapi.json (or GET /v1/openapi.json)
  • AsyncAPI (WebSocket): GET /asyncapi.json (or GET /v1/asyncapi.json)

Versioning

The API prefix is currently /v1. When integrating, treat the spec documents above as the source of truth for the exact endpoint set and payload schemas.