Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

Pending media queue

Video requests waiting to play, oldest first, plus playback state. Requires media:read.

GET/media/queue
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
200

Queue state and items.

is_pausedboolean
visibleboolean

Whether the media player is shown on the overlay.

playingboolean
current_order_idstring | null
queue_modestring

Same as on the TTS queue.

Allowed:separatelinked
itemsQueueMediaItem[]
Show properties
Array of QueueMediaItem
order_idstring
donor_namestring
media_urlstring<uri>
media_start_timeinteger

Start offset in seconds.

video_titlestring | null
video_thumbnailstring<uri> | null
video_durationinteger

Duration in seconds (0 = unknown).

platformstring
requested_viastring

tip | chat | admin | channel_point | ...

is_replayboolean
queued_atstring<date-time>
401

Missing 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).

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

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

required_scopestring
429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Request
curl -X GET 'https://api.tippage.com/v1/media/queue' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "is_paused": true,
  "visible": true,
  "playing": true,
  "current_order_id": "string",
  "queue_mode": "separate",
  "items": [
    {
      "order_id": "string",
      "donor_name": "string",
      "media_url": "http://example.com",
      "media_start_time": 0,
      "video_title": "string",
      "video_thumbnail": "http://example.com",
      "video_duration": 0,
      "platform": "youtube",
      "requested_via": "string",
      "is_replay": true,
      "queued_at": "2019-08-24T14:15:22Z"
    }
  ]
}