What's playing right now
The TTS currently claimed as playing, if any. TTS audio has no known duration, so there is no live position - started_at is when the claim was made, which is enough to spot a consumer that died mid-item. Requires tts:read.
/tts/nowAuthorizationBearer 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.
Current playback state.
playingbooleanA TTS is claimed as playing right now.
is_pausedbooleantipQueueTip | nullShow propertiesHide properties
order_idstringnamestringDisplay name (post-filter).
amountnumber | nullmessagestring | nullThe tip message (post-filter - what shows on stream).
tts_urlstring<uri> | nullAudio for this tip. AI-voice tips are rendered at payment; standard voices are rendered when an alert box first plays the tip (in that box's voice) or the streamer previews it - null until then. Listen for tip.tts_ready.
is_replaybooleanis_sub_rewardbooleansourcestringWhere the tip came from: stripe, paypal, manual (dashboard manual tip), api (POST /tips), sub_reward, replay, test, ayupcc, or unknown for tips older than source tracking.
external_sourcestring | nullDeveloper-API tips only - the source label the caller sent (kofi, ayupcc); null for every other source. Says where the tip came from, not whether money moved - see is_paid.
external_refstring | nullDeveloper-API tips only - the caller's own payment reference.
is_paidbooleanReal money changed hands (Stripe, PayPal, or a developer-API tip sent with paid: true). false for manual tips, free integration tips and sub rewards - those never count toward the streamer's totals.
platformstring | nullThe platform of the account the donor was signed in with when they tipped; null for an unattributed tip.
twitchkicknullplatform_user_idstring | nullThe donor's id on that platform, when signed in.
name_was_filteredbooleanmessage_was_filteredbooleanqueued_atstring<date-time>nullstarted_atstring<date-time> | nullWhen the current TTS was claimed.
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_scopestringRate limit exceeded - check the RateLimit-* headers.
errorstring