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.

• 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)

Interactive API Reference

Browse endpoints, send requests from your browser, and inspect live responses.

Search API

Introduction

Engine Control

GETGet Engines

GETGet a Single Engine

GETGet Nodes of an Engine

GETGet a Single Node

GETGet Properties of a Node

Get a Single Engine

GET/api/rest/v1/engines/{engineId}

Request

fetch('http://127.0.0.1/api/rest/v1/engines/1', {
  headers: { 'X-API-Key': '····' }
})

Test Request

200 OK

{
  "id": 1,
  "name": "Engine-01",
  "ip": "127.0.0.1",
  "role": "broadcast",
  "status": "connected"
}

Launch Interactive API Playground

Downloading Reality Hub's OpenAPI Specs

...

reality-hub-api.yaml

Open

Reality Hub's OpenAPI Specs

You can download the OpenAPI spec by clicking on the download link above. You can upload this file to your AI assistant for reference when developing your Custom Module.

Authentication

All API requests require proper authentication headers. See REST API Key Authentication

Additional Notes

You can also trigger the Download function of the ExternalData field as shown below:

• http://127.0.0.1/api/rest/v1/playout/rundowns/{rundownId}/items/{itemId}/{ExternalDataFieldKey}