Skip to content

API Reference

Interactive docs

Every RomM instance hosts two renderings of its own spec:

  • Swagger UI at {romm_url}/api/docs: explore + try endpoints inline
  • ReDoc at {romm_url}/api/redoc: cleaner reading layout

The raw spec:

{romm_url}/openapi.json

For code generation, see Consuming OpenAPI.

WebSockets

REST isn't the only surface. Two socket.io endpoints cover live-update and coordination use cases: WebSockets.

Versioning

The API follows SemVer along with the rest of RomM:

  • Breaking changes only in major versions. Endpoint removal, required-parameter changes, incompatible response-schema shifts
  • Minor versions add endpoints, optional parameters, optional response fields.
  • Patch versions fix bugs without schema changes.

See also