Guides
A guide takes you from an empty terminal to a working result, with curl at every step. The
REST reference documents every endpoint. A guide tells you which ones to call, in which
order, and what to keep from each answer.
| Guide | What it covers |
|---|---|
| Score a match from your system | Create a match, post the facts as the match runs, and close it |
| Automate a stream | Preview, go live, switch the overlay, pause and stop |
| Configure a stream | Create an input, save a destination, create the stream of a match and link them |
| Receive webhooks | Stand up an endpoint, verify the signature, answer fast, and read the delivery log |
| Publish a theme version | Read the theme, pin graphic versions, publish, and activate. Beta |
| Build a code graphic | From one HTML file to a graphic on an overlay. In the Graphics SDK section. Beta |
| Import a Rive graphic | From a source project to a native preset on an overlay. Beta |
Every guide uses a write key and https://api.ligr.live/rest. Set LIGR_API_KEY in your shell
before you start. See Your first request if you have no key yet.
Two shorter tasks have their own reference pages.
- Fire a graphic on an overlay: Graphics commands and Presets.
- Push a spreadsheet or JSON into a theme: External data sources.