Claim a media item as now playing
Marks a queued media item as currently playing - the same call the overlay makes when it starts a video. Fires queue.media.started and sets the timing anchor that /media/now reads. Refused with 409 queue_paused while the media queue is paused. Unlike the TTS claim there is no already-playing gate: pacing is the consumer’s job. If your player then fails and the item should not count as played, undo the claim with release instead of finishing. See claim, do your thing, finish. Requires media:control.
/media/{orderId}/startAuthorizationBearer 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.
orderIdstringrequiredThe media item's order id - the only external row reference.
Claimed.
successbooleanmediaQueueMediaItemA media item in the pending queue.
Show propertiesHide properties
order_idstringdonor_namestringmedia_urlstring<uri>media_start_timeintegerStart offset in seconds.
video_titlestring | nullvideo_thumbnailstring<uri> | nullvideo_durationintegerDuration in seconds (0 = unknown).
platformstringrequested_viastringtip | chat | admin | channel_point | ...
is_replaybooleanqueued_atstring<date-time>Missing 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_scopestringNo such resource.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
queue_paused - the media queue is paused.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Rate limit exceeded - check the RateLimit-* headers.
errorstring