Bot status
Whether the chat bot is switched on, and per platform (Twitch, Kick) the chat it’s in and the identity it speaks as - on Twitch the shared TipPageBot or the streamer’s linked custom bot, on Kick always the TipPage app account. A platform the streamer hasn’t connected is null. Any valid key.
/botAuthorizationBearer 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.
Bot status.
botobjectShow propertiesHide properties
enabledbooleanThe bot is switched on in at least one connected chat (see platforms for each).
platformsobjectOne entry per platform - null when the streamer has no channel there.
Show propertiesHide properties
twitchBotPlatform | nullShow propertiesHide properties
enabledbooleanThe streamer's on/off switch for the bot in this chat.
channelstringThe streamer's login on this platform.
identityobjectWho the bot's messages appear from. On Kick always the TipPage app account (default).
Show propertiesHide properties
typestringdefaultcustomloginstringdisplay_namestringnullkickBotPlatform | nullShow propertiesHide properties
enabledbooleanThe streamer's on/off switch for the bot in this chat.
channelstringThe streamer's login on this platform.
identityobjectWho the bot's messages appear from. On Kick always the TipPage app account (default).
Show propertiesHide properties
typestringdefaultcustomloginstringdisplay_namestringnullMissing 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).
Rate limit exceeded - check the RateLimit-* headers.
errorstring