The Tipjai platform api v1, schema v5

Build on Tipjai
without touching
anyone's money

Read public data right away with no key, and nothing public touches money. Connect agents over Remote MCP, receive signed events by webhook, and put a tip button on your site. With your own personal key, your bot reads your confirmed tips, totals and income file, sends other platforms' events to your alert box and controls your subathon timer. Nobody gets payout details, slips or anyone else's private data.

In plain wordsIf you run a website, a bot or a system of your own, this page shows how to use what anyone can already see on a creator's page, and how to get told when a tip comes in. If you are a creator, you can also make a personal key so your bot reads your own tips. A key sees only your data, and nobody gets access to money, account numbers or slips.

0keys needed for public data
6public MCP tools, read-only, and 3 more with a key
20Link page templates
Tip me
POST tip.confirmed X-Tipjai-Signature v1=e8a89c93dfba…
tools/list tipjai_link_get_public_page tipjai_link_validate_draft
GET /api/v1/creator/tipjai "tip_url": "…/tipjai"
Slips, payout accounts
Embed buttonembed.js
WebhookHMAC-SHA256
Remote MCP/api/mcp
REST API/api/v1
Never exposedslips and payout accounts sit at the bottom
Slips and payout accounts have no way in from outside.
  • Embed buttonembed.js
  • WebhookHMAC-SHA256
  • Remote MCP/api/mcp
  • REST API/api/v1
  • Slips and payout accountsnever exposed
Start in 30 seconds

Send your first request
from anywhere

  1. 1No sign-up, no key public endpoints are open to read
  2. 2CORS is open call from a browser, a server or an agent
  3. 3The same data as the web page no PromptPay, no drafts, no tip-by-tip history
GET /api/v1/creator/tipjai
curl https://tipjai.com/api/v1/creator/tipjai
200application/jsonA real response from tipjai.com, 27 Sep 2026 19:40 (avatar_url removed to keep it short)
{
  "username": "tipjai",
  "display_name": "tipjai.official",
  "bio": "",
  "accent_color": "#D63C4A",
  "category": "talk",
  "categories": [
    "talk",
    "edu",
    "art"
  ],
  "verified": false,
  "verified_handle": null,
  "views": 61,
  "support_activity_visible": true,
  "total_received": 0,
  "supporters": 0,
  "socials": {
    "youtube": "https://www.youtube.com/@Tipjaiofficial",
    "tiktok": "https://www.tiktok.com/@tipjai.official",
    "facebook": "https://www.facebook.com/profile.php?id=61590195677153",
    "x": "https://x.com/Tipjai_official",
    "instagram": "https://www.instagram.com/tipjai.official/",
    "bluesky": "https://bsky.app/profile/tipjai.bsky.social"
  },
  "tip_url": "https://tipjai.com/tipjai"
}
What you can connect

Seven ways in, pick the one for your job

Link API and MCP spec in OpenAPI 3.1 →

No code neededConfirmed tips can post into your Discord channel or your Telegram chat. Set it up in Studio on the Connections and notifications page (เชื่อมต่อและแจ้งเตือน): press Set up (ตั้งค่า) on each card, and each has a test button. This is a Studio setting, not an API.

Personal key

Let your bot read your
own tips with a key

Create a key in Studio on the API and webhooks page and pick only the permissions it needs. Up to 10 keys, free on every plan. A key is shown once when you create it and can be revoked at once. Use it from your own server or bot only, never in a web page.

Five permissions, pick one by one
  • tips:read
    Read confirmed tips
  • stats:read
    Read daily totals
  • export:read
    Download the income statement as CSV
  • events:write
    Send other platforms' events to your alerts (never counted as money)
  • timer:write
    Control the subathon timer: add, subtract, pause, resume
Embed button

A tip button on your site, in one line

Paste this line into your Carrd, WordPress or HTML page. The button appears where you paste it and opens your tip page on tipjai.com in a new tab. The payment page is never embedded in anyone's site, for safety.

<script src="https://tipjai.com/embed.js" data-tipjai="your-name" data-label="Tip me"></script>
Tip meTip meTip meTip me
  • data-tipjai your link name (tipjai.com/this-name)
  • data-label the button text, up to 40 characters; without it the button says ทิปเลย (Thai for tip me)
  • data-theme coral dark light outline
  • data-size sm md lg

You do not have to write it by hand. Studio's Share and QR page (แชร์และ QR) has the label, theme and size pickers with a live preview and a copy button. See the Share and QR guide (Thai).

Overlay URLs

The alert card and 13 more widget routes

They all use the same token as the creator's alert card URL. Add each one as a 1920 x 1080 Browser Source (TikTok LIVE Studio calls it a Link Source), except the League card, which is small and takes 420 x 200. The token belongs to one account: never show it on stream.

The general shape is /overlay/{token}/{widget}, with a widget name from the list below. Every one of these pages sets a transparent background by itself, so you can paste the link and use it. The countdown page (Countdown, in Studio's free tools) works as a Browser Source too, at /countdown?...&overlay=1. Everything is in its link, so editing later means sharing a new link.

  • /overlay/{token}Alert card
  • …/goalTip goal bar
  • …/leaderboardTop supporters
  • …/topTop supporter, one name on stream
  • …/recentLatest tip, one name on stream
  • …/walkerWalker, supporter characters along the bottom
  • …/tickerTip strip
  • …/chatTwitch and YouTube live chat, merged if you like
  • …/mediaMedia Share
  • …/leagueTipjai League, add ?lang=en for English
  • …/utilityClock and timer, including Subathon
  • …/battleTip battle
  • …/queue?q={queue-id}Request queue, one link per queue
  • …/sceneScene, one source for many widgets
Our security promises

Build on top without touching
a creator's money

The public layers are read-only. A personal key reads only its owner's data and can write in just two ways, neither of which touches money. Access today is by a creator's own personal key only, and each key can do only the permissions its creator picked.

  • No public tool writes, publishes or deletes
  • No public layer has PromptPay, bank accounts or tip-by-tip lists, only the supporter leaderboard a creator chooses to show
  • A personal key reads only its owner's own confirmed tips and totals, including the supporter names and messages on those tips
  • It can write in only two ways: send events that are never money, and move the subathon clock
  • It cannot move money, confirm or change tips, change payment destinations, or read any other creator's private data
  • A key is shown once, you can have up to 10, and you can revoke one at once
  • Every URL and input is bounded
  • Host and Origin checks, and rate limits
ถามคู่มือdocs.tipjai.com
เริ่มใช้ Tipjai ในสามขั้นเริ่มต้น↵เอาการ์ดน้ำใจขึ้น OBSขึ้นจอ / OBS Studioใส่ลิงก์การ์ดใน TikTok LIVE Studioขึ้นจอ / TikTok LIVE Studioแต่งการ์ดในหน้าแจ้งเตือนและวิดเจ็ตขึ้นจอ / แจ้งเตือนและวิดเจ็ตเลือกเสียงอ่านข้อความลูกเล่น / เสียงอ่านแชร์และ QR คัดลอกลิงก์หน้าทิป และพาแฟนมาที่หน้าทิปรับเงิน / แชร์และ QRบันทึก QR เป็นรูป พิมพ์ หรือส่งร้านพิมพ์รับเงิน / แชร์และ QRแต่งสีและรูปกลาง QR ของหน้าทิปรับเงิน / แชร์และ QRแชร์ไป X Facebook LINE คัดลอกแคปชั่น และการ์ดตอนแชร์ลิงก์รับเงิน / แชร์และ QRปุ่มทิปบนเว็บของคุณ ฝังโค้ดบรรทัดเดียวรับเงิน / แชร์และ QRตั้งพร้อมเพย์และช่องทางรับเงินรับเงิน / ช่องทางรับเงินปิดทิปเล่น: สวิตช์ ต้องแนบสลิปก่อน การ์ดถึงจะขึ้นจอรับเงิน / กติกาการทิปทิปที่ยังไม่ขึ้นจอ และรายการที่ปิดให้แล้วรับเงิน / หน้าทิปของ Studioเปลี่ยนที่อยู่หน้า tipjai.com/ชื่อใหม่รับเงิน / แชร์และ QRออกแบบกรอบรูปโปรไฟล์ และคอลเลกชันของฉันฟีเจอร์ / ขายและสมาชิกค้นหาใน Studio และ ช่วยเหลือและคู่มือฟีเจอร์ / เครื่องมือช่วยงานปิดเสียงอ่านทิป และความดังเสียงลูกเล่น / เสียงอ่านส่งทิปยังไง และเงินไปไหนคนส่งทิปสลิปทำงานยังไง ป้ายบนทิปแปลว่าอะไรรับเงิน / สลิปยืนยันอัตโนมัติ ไม่ต้องแนบสลิปรับเงิน / ยืนยันอัตโนมัติภาพรวมของ Studio: ยอดเงินบวกกันยังไงรับเงิน / สลิปและการยืนยันเชื่อมต่อและแจ้งเตือน Discord มือถือ Telegram และ webhook ในหน้าเดียวฟีเจอร์ / เครื่องมือช่วยงานลิงก์ OBS ซ่อนเป็นจุด กดแสดงเพื่อดูทั้งเส้นขึ้นจอ / OBS Studioหน้ารวมลิงก์แบบปัดทีละการ์ดฟีเจอร์ / หน้าของคุณคำขอบคุณสำเร็จรูป 5 แบบในหน้าผู้สนับสนุนฟีเจอร์ / เครื่องมือช่วยงานช่องทางรับเงิน เรียงยังไง และแถวที่พับไว้ (Opn, Paynoi)รับเงิน / ช่องทางอื่นชื่อใหม่ของหน้าใน Studio (ชื่อเดิมค้นเจอ)ฟีเจอร์ / เครื่องมือช่วยงานเปิดหน้าทิปบนมือถือเครื่องเดียวกับแอปธนาคาร: บันทึก QRคนส่งทิป / สแกน QRซองอั่งเปา TrueMoneyรับเงิน / ช่องทางอื่นไฟล์ CSV รายรับสำหรับยื่นภาษีรับเงิน / ภาษีโคลนเสียงของคุณเองลูกเล่น / เสียงอ่านแฟนอัดเสียงตัวเองขึ้นจอลูกเล่น / เสียงอ่านคลิปวิดีโอจากผู้สนับสนุนลูกเล่น / คลิปวิดีโอบัญชีรับเงินที่รู้จักและสลิปกรุงไทยรับเงิน / บัญชีรับเงินทิปที่รอครีเอเตอร์ตรวจยอดรับเงิน / รายการรอตรวจตัดต่อคลิปและย้อนกลับด้วย Undo/Redoเครื่องมือ / Editorฟีเจอร์ทั้งหมดของ Tipjaiฟีเจอร์ทั้งหมดหลอดโด Subathon และวิดเจ็ตบนจอฟีเจอร์ / ลูกเล่นบนจออัปเดตล่าสุดของ Tipjaiอัปเดตรายได้และภาษี รายงานรายได้ในหน้าเดียวรับเงิน / รายได้และภาษีพิมพ์หรือดาวน์โหลดรายงานรายได้เป็น PDFรับเงิน / รายได้และภาษีลิงก์ยืนยันรายงานรายได้ให้ธนาคารตรวจสอบรับเงิน / รายได้และภาษีสถิติหน้ารับทิป คนเข้าหน้า ชั่วโมง วัน และที่มารับเงิน / รายได้และภาษีผู้ช่วยภาษีปี 2569 ต้องยื่น ภ.ง.ด.90 ไหมรับเงิน / รายได้และภาษีเปิดร้านค้าและลงสินค้าใน Studioขายของ / ร้านค้าและออเดอร์ดูและจัดการออเดอร์ร้านค้า แท็บตรวจสลิป รอยืนยัน จ่ายแล้วขายของ / ร้านค้าและออเดอร์ผู้ซื้อแนบสลิป ธนาคารตรวจ และปุ่ม ให้ธนาคารตรวจอีกครั้งขายของ / ร้านค้าและออเดอร์คืนเงินผู้ซื้อ กดคืนเงินแล้วขายของ / ร้านค้าและออเดอร์จัดส่งพัสดุ ใส่เลขพัสดุ หรือส่งมอบด้วยตัวเองขายของ / ร้านค้าและออเดอร์พิมพ์ใบปะหน้า ใบแพ็กของ และใบเสร็จขายของ / ร้านค้าและออเดอร์ทำทีละหลายออเดอร์ และส่งออก CSVขายของ / ร้านค้าและออเดอร์สร้างคิวคำขอให้ผู้ชมจ่ายเพื่อขอเพลงขึ้นจอ / คิวคำขอเปิดรับคำขอ ผู้ชมเห็นอะไรบนหน้าทิปขึ้นจอ / คิวคำขอการ์ดคิวบน OBS กำลังทำ คิวถัดไปขึ้นจอ / คิวคำขอทำคำขอทีละคนบนบอร์ดคิวขึ้นจอ / คิวคำขอคำขอที่ยังไม่เข้าคิว ยอดไม่ถึงราคา ไม่มีสลิปขึ้นจอ / คิวคำขอฉากรวม ลิงก์เดียวใส่ได้หลายวิดเจ็ตใน OBSขึ้นจอ / วิดเจ็ตและฉากรวมลากวิดเจ็ตไปวางในฉากรวม ย้ายและปรับขนาดขึ้นจอ / วิดเจ็ตและฉากรวมเลือกฟอนต์ของวิดเจ็ตขึ้นจอ / วิดเจ็ตและฉากรวมชุดวิดเจ็ตพร้อมใช้ เล่นเกม คุยสบาย ๆ เพลง มินิมอลขึ้นจอ / วิดเจ็ตและฉากรวมพื้นหลังตัวอย่าง และตัวอย่างที่ตรงกับบนจอจริงขึ้นจอ / วิดเจ็ตและฉากรวมเปิดยืนยันสองขั้นตอนด้วยรหัสจากแอปในโทรศัพท์บัญชีและทีม / ความปลอดภัยบัญชีเพิ่มแอปสำรอง ไม่มีรหัสสำรองแบบพิมพ์บัญชีและทีม / ความปลอดภัยบัญชีจำอุปกรณ์นี้ 30 วัน และเลิกจำอุปกรณ์บัญชีและทีม / ความปลอดภัยบัญชีเพิ่ม Passkey เข้าสู่ระบบด้วยลายนิ้วมือหรือใบหน้าบัญชีและทีม / ความปลอดภัยบัญชีสร้างเอเจนซีและตั้งชื่อลิงก์ (handle)บัญชีและทีม / เอเจนซีเชิญครีเอเตอร์เข้าเอเจนซีด้วยชื่อผู้ใช้บัญชีและทีม / เอเจนซีตอบรับหรือปฏิเสธคำเชิญเข้าเอเจนซีบัญชีและทีม / เอเจนซีเจ้าของ ผู้ดูแล สมาชิก ทำอะไรได้บ้างบัญชีและทีม / เอเจนซีให้ทีมดูทิปและรายได้ เปิดเอง ปิดได้ทุกเมื่อบัญชีและทีม / เอเจนซีเลือกเสียงอ่านจากคลังเสียงลูกเล่น / เสียงอ่านตั้งค่าทั่วไปไปไหน เสียงอ่านทิป สิ่งที่หน้าแสดง และ #tip-pulseลูกเล่น / เสียงอ่านแก้กล่องทิป ยอดแนะนำ ข้อความลัด คำบนปุ่ม และเอฟเฟกต์ใน แต่งโปรไฟล์รับเงิน / กล่องส่งทิปบนหน้าให้ทิปของคุณขึ้นห้อง #tip-pulse ใน Discord ชุมชน Tipjaiฟีเจอร์ / เครื่องมือช่วยงานสติกเกอร์และเสียงของคุณเองลูกเล่น / สติกเกอร์ส่งสติกเกอร์ไปกับทิปคนส่งทิป / สติกเกอร์ส่งคำขอเข้าคิวให้ครีเอเตอร์คนส่งทิป / คิวคำขอMedia Share ให้ผู้ชมส่งรูป เสียง วิดีโอ และคลิป YouTube ขึ้นจอขึ้นจอ / Media Shareเลือกชนิดสื่อที่รับ ตรวจทีละอันหรือเล่นทันทีขึ้นจอ / Media Shareตรวจและอนุมัติสื่อจากผู้ชมในหน้าระหว่างไลฟ์ขึ้นจอ / Media Shareให้ผู้ช่วยตรวจสื่อแทนด้วยลิงก์ ไม่ต้องมีบัญชีขึ้นจอ / Media Shareบล็อกช่อง คลิป คำในชื่อคลิป หรือชื่อผู้ส่งขึ้นจอ / Media Shareประวัติคำขอ คืนเข้าคิว และการ์ดคิวในหน้าระหว่างไลฟ์ขึ้นจอ / คิวคำขอร่วม Tipjai League ลีกรายเดือนที่หน้าศึกน้ำใจขึ้นจอ / Tipjai Leagueคะแนน Tipjai League คิดยังไง สูตรเปิดเผยขึ้นจอ / Tipjai Leagueเงินแบบไหนนับเป็นคะแนนลีก แบบไหนไม่นับขึ้นจอ / Tipjai Leagueการ์ดอันดับ Tipjai League บน OBSขึ้นจอ / Tipjai Leagueเหรียญสามอันดับแรกของซีซัน และเงินรางวัลขึ้นจอ / Tipjai Leagueโยนของใส่โมเดล VTuber เมื่อมีทิปขึ้นจอ / โยนของใส่โมเดล VTuberต่อ VTube Studio หรือ VRChat กับ Photonขึ้นจอ / โยนของใส่โมเดล VTuberตั้งระดับทิป ของที่โยน และรูปของคุณเองขึ้นจอ / โยนของใส่โมเดล VTuberทิปแบบไหนที่โยนของใส่โมเดลขึ้นจอ / โยนของใส่โมเดล VTuberผู้สนับสนุนอันดับ 1 และทิปล่าสุด ชื่อเดียวบนจอขึ้นจอ / วิดเจ็ตและฉากรวมตัวละครผู้สนับสนุนเดินที่ขอบล่างของจอขึ้นจอ / วิดเจ็ตและฉากรวมแท่นรางวัล ตัวเลขวิ่ง การเติมหลอด และแชท Twitch กับ YouTube รวมกันขึ้นจอ / วิดเจ็ตและฉากรวมร้านพร้อมขายหรือยัง รายการเช็กความพร้อมของร้านขายของ / ร้านค้าและออเดอร์หน้าร้านและหน้าสินค้าที่ผู้ซื้อเห็น แถบสั่งซื้อบนมือถือขายของ / ร้านค้าและออเดอร์หน้าคำสั่งซื้อของผู้ซื้อ ไทม์ไลน์สถานะขายของ / ร้านค้าและออเดอร์
QR ขึ้นว่าสีนี้อ่อนไป หรือสแกนไม่ติดแก้ปัญหา / แชร์และ QRจ่ายแล้วแต่ยังรอยืนยันคนส่งทิป / ทำรายการเดิมต่อทิปจากคอม แต่สลิปอยู่ในมือถือแก้ปัญหา / คนส่งทิปการ์ดไม่เด้งบน OBSแก้ปัญหา / ขึ้นจอไม่ได้ยินเสียงอ่านแก้ปัญหา / ขึ้นจอการ์ดเล็กไปหรือภาพแตกแก้ปัญหา / ขึ้นจอTikTok LIVE Studio การ์ดไม่ขยับ หรือขึ้นแต่ไม่มีเสียงแก้ปัญหา / ขึ้นจอหน้า ระหว่างไลฟ์ บอกว่ายังไม่เชื่อมต่อแก้ปัญหา / ขึ้นจอสลิปไม่ผ่านแก้ปัญหา / รับเงินแฟนเปิดจาก TikTok แล้วแนบสลิปไม่ได้แก้ปัญหา / คนส่งทิปไม่อยากให้ใครเห็นยอดรวมแก้ปัญหา / ความเป็นส่วนตัวการ์ดคิวไม่ขึ้นบนจอ หรือผู้ชมไม่เห็นคิวแก้ปัญหา / คิวคำขอวางลิงก์ฉากรวมแล้วจอว่างเปล่าแก้ปัญหา / วิดเจ็ตและฉากรวมเปลี่ยนบัญชีรับเงินแล้วถามรหัสอีกแก้ปัญหา / ความปลอดภัยบัญชีโทรศัพท์หาย ใส่รหัสยืนยันสองขั้นตอนไม่ได้แก้ปัญหา / ความปลอดภัยบัญชีตอบรับคำเชิญเอเจนซีไม่ได้ หรือสร้างเอเจนซีไม่ได้แก้ปัญหา / เอเจนซีสติกเกอร์หรือเสียงที่แฟนเลือกไม่ขึ้นบนการ์ดลูกเล่น / สติกเกอร์กดทดสอบแล้วไม่เห็นของลอยเข้าโมเดลแก้ปัญหา / โยนของใส่โมเดล VTuberตัวละครผู้สนับสนุนหรือลีก Tipjai บนจอว่างอยู่แก้ปัญหา / วิดเจ็ตและฉากรวมเลือกแท่นรางวัลหรือการเติมหลอดแล้ว บนจอยังเหมือนเดิมแก้ปัญหา / วิดเจ็ตและฉากรวมผู้ซื้อสั่งซื้อจากร้านไม่ได้แก้ปัญหา / ร้านค้า
ลิงก์การ์ดและวิดเจ็ต (Overlay URL)นักพัฒนา / Overlay URLWebhook tip.confirmedนักพัฒนา / Webhookดึงโปรไฟล์ครีเอเตอร์ GET /api/v1/creatorนักพัฒนา / REST APIRemote MCP สำหรับ agentนักพัฒนา / Remote MCPปุ่มทิปฝังเว็บ embed.jsนักพัฒนา / ปุ่มฝังเว็บคีย์ API ส่วนตัวและสิทธิ์ของคีย์นักพัฒนา / คีย์และสิทธิ์อ่านทิป ยอดรวม และไฟล์รายรับของคุณด้วยคีย์ (GET /api/v1/me)นักพัฒนา / Private APIส่งอีเวนต์จากแพลตฟอร์มอื่นขึ้นจอแจ้งเตือน (POST /api/v1/me/events)นักพัฒนา / Private APIคุมนาฬิกาซับบาธอนด้วย API (POST /api/v1/me/timer)นักพัฒนา / Private APIRemote MCP พร้อมคีย์ (tipjai_my_tips, tipjai_timer_control)นักพัฒนา / Remote MCPบล็อกคัดลอกข้อความ (copy) และ Link schema v5นักพัฒนา / Link APIทิปเข้า Telegram หรือ Discord (ไม่ต้องใช้ API)นักพัฒนา / แจ้งเตือน
↑↓เลือก↵เปิดescปิดค้นได้ทั้งคำไทยที่เขียนติดกัน และคำอังกฤษ