Release a claimed TTS back to the queue
The undo of start, for when your effect didn’t go to plan - the audio device failed, your process is shutting down mid-item, the effect errored before anything played. Drops the now-playing claim WITHOUT finishing: the tip stays in the queue at its position, the slot frees, and the tip can be claimed again (by you after recovering, or by any other consumer). Fires queue.tts.released. Only drops a claim that actually points at this order id - it can never kick out a different tip’s claim, and releasing something you don’t hold is a safe no-op (released: false). If the tip DID play, use finish instead so it lands in history. Requires tts:control.
/tts/{orderId}/releaseAuthorizationBearer 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 tip's order id (e.g. tip_1755100000000_ab12cd) - the only external row reference.
Released (released: false when there was no claim to drop).
successbooleanreleasedbooleanWhether a now-playing claim was actually dropped.
tipQueueTip | 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>nullMissing 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