Is an overlay connected?
Whether any of the account’s overlays holds a live realtime connection right now - without one, nothing you queue plays. Needs tts:read or media:read (not overlays:manage): it is the fact both queues share.
/overlays/connectedAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
The connected overlays.
connectedbooleanmedia_screenbooleanA connected overlay carries a media-screen widget, so showing or hiding the video on stream has an effect.
overlaysobject[]Show propertiesHide properties
objectidstringnamestring | nullmedia_screenbooleanMissing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringRate limit exceeded - check the RateLimit-* headers.
errorstring