Star OS
Reference

API reference

Where to find the current generated API specifications and interactive reference.

Product API

The Product API is generated from the application's Hono and Zod route definitions as an OpenAPI 3.1 document. It is used by the Star OS dashboard and administration tools.

It is not yet a public SDK surface. Until a public-only contract is published, use the interactive reference only for supported product integrations:

  • GET /openapi.json — machine-readable OpenAPI document
  • GET /docs — interactive Scalar API reference
  • GET /docs/postman.json — Postman collection

Public inference API

The public inference API is a Gateway surface and has a separate contract from the Product API. Its documentation will be published on this site only after the Gateway team provides a public, customer-safe OpenAPI specification.

This separation prevents internal administration routes, service-token flows, and dashboard-only APIs from being exposed as customer integration endpoints.

On this page