Connecting to Singular.live
Set up your Singular.live API token and App ID to trigger IN and OUT on your compositions from Helmo Live.
TutorialBeginnerUpdated
Connect your Singular.live account to Helmo Live for overlay control and content updates.
Prerequisites
- A Singular.live account with at least one app (composition) created.
- Your Singular.live API Token (found in your Singular.live dashboard under Account → API).
- The App ID of the composition you want to control.
Connecting in Helmo
- Go to Connect and click + Add Integration.
- Select Singular.live as the type.
- Enter a name (for example, "Singular Lower Thirds").
- Paste your API Token. It is encrypted and stored securely.
- Enter the App ID of the Singular composition.
- Click Test Connection to verify, then Save.
Available actions
Once connected, you can trigger these from Helmo Control buttons or Action Sequences:
| Action | Description |
|---|---|
| IN | Animate the overlay in (make it visible on air). |
| OUT | Animate the overlay out (remove it from air). |
Tip
Singular.live uses a direct HTTP connection, so no middleware is needed. Helmo sends commands directly to Singular's cloud API.
Watch out
PATCH actions (updating fields on a live overlay) are currently under investigation. IN and OUT commands work reliably.
How credentials are stored
Your API Token is encrypted at rest using pgp_sym_encrypt and only decrypted server-side when executing a command. It is never exposed in the browser or stored in plain text.