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.

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

  • Base URL: Your current RealityHub address and port (ex: http://localhost)

  • Endpoint: Communication channel that you want to do various processes (/api/rest/v1/engines/1/nodes)

If the Endpoint contains characters that the URL doesn't support, those characters should be URL-Encoded. For more information, please visit: HTML URL Encoding Reference

Additional Notes

  • You can also trigger the Download function of the ExternalData field as shown below:{rundownId}/items/{itemId}/{ExternalDataFieldKey}

Last updated