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.

GET/overlays/connected

Authorization

AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A 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.

Responses

200The connected overlays.

connectedboolean

media_screenboolean

A connected overlay carries a media-screen widget, so showing or hiding the video on stream has an effect.

overlaysobject[]

Show properties

Array of object

idstring

namestring | null

media_screenboolean

401Missing or invalid credential (`missing_api_key` / `invalid_api_key`, or `invalid_token` for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

required_scopestring

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/overlays/connected" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/overlays/connected", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/overlays/connected",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "connected": true,
  "media_screen": true,
  "overlays": [
    {
      "id": "string",
      "name": "string",
      "media_screen": true
    }
  ]
}