Start here

Welcome, and thank you for buying an Epiphan Video Pearl system. This guide is for our Legacy API system, we recommend using our new REST API, https://epiphan-video.github.io/pearl_api_swagger_ui/.

This Legacy API guide provides the information you need to successfully set up and operate Pearl-2™, Pearl Mini™,Pearl Nexus™, and Pearl Nano™ using the Legacy APIs, including:

  • RS-232 API
  • HTTP/HTTPS API

The Legacy API integrations section contains what you need to know about using these APIs with your Pearl system.

The Configuration keys for third party APIs section provides the detailed API keys.

For firmware compatibility and change history, see What's new and release history.

Throughout this Legacy API guide, the term Pearl system is used to refer to Pearl-2, Pearl Mini, Pearl Nexus, and Pearl Nano collectively. Specific references are used when it's necessary to distinguish between the different models.

This guide assumes that all feature add-ons for Pearl-2 are activated. Features or tasks that only apply when a feature add-on is activated is indicated in the text.

Examples of third party control systems built using Pearl API are: