Skip to main content
Version: RealityHub 1.3

REST API

A REST API is an architectural style for an application program interface (API) that uses HTTP requests to access and use data. That data can be used to GET, POST, PATCH, and DELETE data types, referring to the reading, updating, creating, changing, and deleting operations concerning resources.

info

REST API is a licensed feature. For more details, please get in touch with our Licensing Team.

  • Base URL: Your current Reality Hub address and port (ex: http://localhost)
  • Endpoint: Communication channel that you want to do various processes (/api/rest/v1/engines/1/nodes)

Downloading OpenAPI YAML File​

REST API File

  • Right-click on the link to the OpenAPI YAML file, and select “Save Link As…” to save it to your local directory.
  • Open the saved file in tools like Postman by importing the file for API testing, or use Swagger Editor to view and explore the API's endpoints visually.