Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview
On this page

Authentication

Create an API key, send it as a bearer token, and pick the scopes it carries.

Create a key in Settings -> Developer (owner and super admins). It’s shown once. Rotating gives the key a new value and the old one stops working at once; rotation is dashboard-only, so a leaked key can’t replace itself.

curl https://api.tippage.com/v1/me -H "Authorization: Bearer tp_live_..."

The key identifies your TipPage, so no URL carries an account id. Keep keys server-side - never in a browser, an overlay, or anything on stream. Building for other streamers? Use OAuth instead of asking for their keys.

Scopes

Scope Grants
tts:read TTS queue and history, including messages and audio URLs, and a queued tip’s audio made on demand
tips:create Add tips TipPage didn’t take payment for. source labels where it came from; paid: true counts it as revenue. Neither = a manual tip
tts:control Pause, resume, skip, clear, remove, replay, and start/finish TTS items
media:read Media queue, history and playback status
media:control Pause, resume, skip, queue videos, show/hide the player
tipping:control Open and close tipping (payments already under way still complete)
viewers:read Viewers and their standing per platform: follow, sub, mod, VIP, credits, sub-reward messages
viewers:manage Grant and revoke sub-reward credits
channel_points:manage Create, list and delete TipPage-created channel point rewards, and fulfil or cancel their redemptions
webhooks:manage Webhook endpoints
timers:manage Chat bot timers
counters:manage Chat counters (writes update overlay labels live)
chat:write Send messages to chat as the bot
commands:manage The bot’s custom !commands
overlays:manage List, delete and reload overlays, fire the celebration widget, edit tip goals
ai_voices:manage AI voices: catalogue, master switch, which voices are offered

No scope covers payments, settings or the team. Tipping status and the leaderboard need no scope - they’re public on the tip page anyway.

Was this page helpful?