Pending TTS queue

The queued TTS entries waiting to be played, oldest first, plus the playback state. tts_url is null until the pre-rendered audio is ready (subscribe to tip.tts_ready or re-poll). Requires tts:read.

GET/tts/queue

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Responses

200Queue state and items.

is_pausedboolean

currently_playingboolean

current_order_idstring | null

order_id of the tip being played right now.

itemsQueueTip[]

Show properties

Array of QueueTip

order_idstring

namestring

Display name (post-filter).

amountnumber | null

messagestring | null

The tip message (post-filter - what shows on stream).

tts_urlstring<uri> | null

Pre-rendered audio; `null` until rendering completes.

is_replayboolean

is_sub_rewardboolean

twitch_user_idstring | null

Present when the donor tipped signed in with Twitch.

name_was_filteredboolean

message_was_filteredboolean

queued_atstring<date-time>

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

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/tts/queue" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

import requests

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

Response

{
  "is_paused": true,
  "currently_playing": true,
  "current_order_id": "string",
  "items": [
    {
      "order_id": "tip_1755100000000_ab12cd",
      "name": "string",
      "amount": 5,
      "message": "string",
      "tts_url": "http://example.com",
      "is_replay": true,
      "is_sub_reward": true,
      "twitch_user_id": "string",
      "name_was_filtered": true,
      "message_was_filtered": true,
      "queued_at": "2019-08-24T14:15:22Z"
    }
  ]
}