How-to guides

Learn how to accomplish common tasks with the Singular REST API

The how-to guides in this section describe most of the common tasks involved in updating and controlling overlays using the Singular REST API. In these guides, you'll learn how to get information about app instances and sub-compositions, as well as how to update overlay content and animate overlays In and Out. They include:

How to get a control app's API token

How to get an overlay's sub-composition ID(s)

How to get a control app's model

How to get a control app's metadata

How to update an overlay's content

How to animate overlays In and Out

How to simultaneously update and overlay and animate it In and Out

How to update multiple sub-compositions in one request

These how-to guides are language and platform agnostic. Thus, you can follow along using cURL or whatever language you use to make API requests, as well as on Postman or the API platform of your choice.

For more basic instructions about getting started with Singular, check out the quick start. The knowledge you gain going through it will enable you to follow the how-to guides here.

These how-to guides require a Singular account, which you can get here.