API reference
endpoint สาธารณะอ่านข้อมูลสาธารณะอย่างเดียว ไม่ต้องใช้คีย์ เรียกจากเบราว์เซอร์ได้ตรง ๆ และกด ส่งคำขอจริง ได้บนหน้านี้ ส่วน Private API ใช้คีย์ส่วนตัวของครีเอเตอร์เอง อ่านได้เฉพาะข้อมูลของเจ้าของคีย์ และเรียกจากเซิร์ฟเวอร์หรือบอทของคุณ ตรวจกับโค้ดและระบบจริงเมื่อ 28 ต.ค. 2569
ภาษาคนAPI คือช่องให้โปรแกรมของคุณขอข้อมูลจาก Tipjai ได้เอง เช่น เอาชื่อ รูป และลิงก์ทิปของครีเอเตอร์ไปโชว์บนเว็บของคุณ ข้อมูลที่ได้จาก endpoint สาธารณะเป็นข้อมูลเดียวกับที่ใครก็เห็นบนหน้าเว็บอยู่แล้ว ถ้าคุณเป็นครีเอเตอร์ จะสร้างคีย์ส่วนตัวให้บอทของคุณอ่านทิปและยอดรวมของคุณเอง ส่งอีเวนต์ขึ้นจอ หรือคุมนาฬิกาซับบาธอนก็ได้
หลักการ
- ที่อยู่หลักคือ
https://tipjai.comทุกคำตอบเป็น JSON แบบ UTF-8 ยกเว้นไฟล์ CSV ของ/api/v1/me/export - endpoint สาธารณะไม่ต้องสมัครหรือขอคีย์ และเปิด CORS ให้ทุก origin (
Access-Control-Allow-Origin: *) ส่วน Private API ต้องใช้คีย์ส่วนตัวของครีเอเตอร์ ดูหัวข้อคีย์และสิทธิ์ และไม่ส่งหัว CORS - endpoint สาธารณะไม่มีช่องทางรับเงิน ไม่มี draft ที่ยังไม่เผยแพร่ และไม่มีประวัติทิปทีละครั้ง ยอดเงินจะขึ้นเฉพาะเมื่อครีเอเตอร์เปิดโชว์ยอดไว้
- Private API อ่านได้เฉพาะข้อมูลของเจ้าของคีย์ ไม่มีเลขพร้อมเพย์ เลขบัญชี หรือสลิป และไม่มีข้อมูลของครีเอเตอร์คนอื่น เขียนได้แค่สองอย่าง คือส่งอีเวนต์ที่ไม่ใช่เงิน และขยับนาฬิกาซับบาธอน
- Link API และ Remote MCP มีสเปกเต็มใน OpenAPI 3.1 ส่วน stats, creator, leaderboard, market และ Private API อธิบายไว้ในหน้านี้ OpenAPI ไม่มีรายการของ Private API
คีย์และสิทธิ์
- endpoint กลุ่ม Private API ใช้คีย์ API ส่วนตัวของครีเอเตอร์ ส่งในส่วนหัว
Authorization: Bearer tj_live_...ทุกคำขอ คีย์ขึ้นต้นด้วยtj_live_และใช้ได้ฟรีทุกแพ็กเกจ แต่ละคีย์ทำได้เฉพาะสิทธิ์ที่เลือกไว้ตอนสร้าง - สร้างคีย์ใน Studio (
studio.tipjai.com/api) เปิดกลุ่ม เครื่องมือฟรี เลือก API และ Webhooks ที่การ์ด คีย์ API ส่วนตัว ตั้ง ชื่อคีย์ (ไม่เกิน 60 ตัวอักษร) ติ๊กสิทธิ์ที่ต้องใช้ แล้วกด สร้างคีย์ หน้า เชื่อมต่อและแจ้งเตือน พามาที่นี่ได้เหมือนกัน จากการ์ด คีย์ API และคู่มือนักพัฒนา - Studio แสดงคีย์เต็มครั้งเดียวตอนสร้างเสร็จ (ป้าย (แสดงครั้งเดียว)) คัดลอกเก็บไว้ตอนนั้น Tipjai เก็บเฉพาะค่าแฮชของคีย์ จึงเปิดให้ดูอีกไม่ได้ ถ้าทำหาย ให้ยกเลิกแล้วสร้างใหม่
- มีคีย์ที่ใช้งานอยู่ได้สูงสุด 10 คีย์ รายการ คีย์ของคุณ บอกชื่อ ส่วนต้นของคีย์ สิทธิ์ เวลาสร้าง และเวลา ใช้ล่าสุด (หรือ ยังไม่เคยใช้) ปุ่ม ยกเลิกคีย์ มีผลทันทีและเปิดคืนไม่ได้ เครื่องมือที่ใช้คีย์นั้นจะเรียก Tipjai ไม่ได้อีก ถ้ายังต้องใช้ ให้สร้างคีย์ใหม่
- การสร้างคีย์ต้องเพิ่งเข้าสู่ระบบไม่นาน ถ้าไม่ใช่ Studio จะขอให้ยืนยันตัวตนอีกครั้ง โดยข้อมูลที่กรอกไว้ยังอยู่ และถ้าเปิดยืนยันสองขั้นตอนไว้ ต้องใส่รหัส 6 หลักล่าสุดจากแอปยืนยันตัวตนด้วย
- ใช้คีย์จากเซิร์ฟเวอร์หรือบอทของคุณเท่านั้น เก็บในตัวแปรสภาพแวดล้อมหรือที่เก็บความลับ อย่าใส่ในหน้าเว็บหรือโค้ดที่คนอื่นเห็น Private API ไม่ส่งหัว CORS จึงไม่ได้ออกแบบให้เรียกจากหน้าเว็บ และหน้านี้ไม่มีปุ่มส่งคำขอจริงของกลุ่มนี้ ถ้าคีย์หลุด ให้ยกเลิกแล้วสร้างใหม่
- นับเฉพาะเงินที่หน้ารายได้และภาษีใน Studio นับ คือทิปที่ยืนยันแล้ว ไม่ใช่ทิปทดสอบ (verification เป็น verified, structural หรือ creator_confirmed) วันอิงเวลาไทย อีเวนต์ที่ส่งเข้ามาไม่ใช่ทิปจึงไม่ปรากฏเลย
- คีย์อ่านได้เฉพาะข้อมูลของเจ้าของคีย์ รวมถึงชื่อและข้อความของผู้สนับสนุนในทิปของครีเอเตอร์คนนั้น เขียนได้แค่ส่งอีเวนต์ที่ไม่ใช่เงิน กับขยับนาฬิกาซับบาธอน ย้ายเงิน ยืนยันหรือแก้ทิป เปลี่ยนช่องทางรับเงิน หรืออ่านข้อมูลส่วนตัวของคนอื่นไม่ได้ ตอนนี้เข้าถึงได้ด้วยคีย์ส่วนตัวของครีเอเตอร์แต่ละคนเท่านั้น
สิทธิ์ทั้งห้า
| สิทธิ์ | ชื่อในการ์ดของ Studio | ใช้กับ |
|---|---|---|
tips:read | อ่านรายการทิปที่ยืนยันแล้ว | GET /me/tips, tipjai_my_tips |
stats:read | อ่านยอดรวมรายวัน | GET /me/stats, tipjai_my_stats |
export:read | ดาวน์โหลดรายการรับเงินเป็น CSV | GET /me/export |
events:write | ส่งอีเวนต์จากแพลตฟอร์มอื่นขึ้นจอ (ไม่นับเป็นเงิน) | POST /me/events |
timer:write | คุมนาฬิกาซับบาธอน เพิ่ม ลด หยุด เดินต่อ | POST /me/timer, tipjai_timer_control |
GET /api/v1/me ใช้ได้กับคีย์ที่ใช้งานได้ทุกอัน ไม่ต้องมีสิทธิ์ใดเลย ส่วน tipjai_* คือเครื่องมือของ Remote MCP เมื่อส่งคีย์ ดูที่ Remote MCP
ข้อผิดพลาดและการจำกัดความถี่
- ข้อผิดพลาดของ endpoint สาธารณะตอบเป็น
{"error":"…"}พร้อมสถานะ HTTP เช่น404429503 - endpoint ที่อ่านข้อมูลครีเอเตอร์ ตลาด สถิติ และ validate เรียกได้ 60 ครั้งต่อนาทีต่อ IP เกินแล้วได้
429พร้อมRetry-Afterและคำตอบนี้ไม่ถูกแคช - แคตตาล็อกของ Link API (templates, platforms, schema, knowledge) เป็นข้อมูลคงที่ แคชที่ CDN 5 นาที และไม่จำกัดความถี่
503แปลว่าระบบอ่านข้อมูลไม่ได้ชั่วคราว ลองใหม่ตามค่าRetry-Afterถ้ามี- Private API ตอบเป็น
{"error":"…","message":"…"}ใช้ค่า error ตัดสินในโค้ด ส่วน message เป็นข้อความภาษาอังกฤษสำหรับคนอ่าน และคำตอบ JSON ทุกอันมีCache-Control: no-storeกับVary: Authorization(ไฟล์ CSV มีแค่ Cache-Control: no-store) ส่วน 401 มีWWW-Authenticate: Bearer realm="tipjai" - Private API นับต่อคีย์ 120 คำขอต่อนาที รวมทุก endpoint และรวมคำขอ MCP ทุกครั้งที่ส่งคีย์ เกินแล้วได้ 429 พร้อม Retry-After นอกจากนี้นับต่อครีเอเตอร์ ไม่ว่าจะใช้กี่คีย์: export 10 ไฟล์ต่อนาที, events 60 อีเวนต์ต่อนาที, timer 30 คำสั่งต่อนาที (รวม REST กับ MCP)
คำตอบเมื่อไม่มีคีย์ คีย์ผิด หรือคีย์ไม่มีสิทธิ์
401 {"error":"missing_api_key","message":"Send your key as Authorization: Bearer tj_live_..."}
401 {"error":"invalid_api_key","message":"This key is not valid, or it was revoked. Create a new one in Tipjai Studio."}
403 {"error":"insufficient_scope","message":"This key does not have the tips:read scope. Create a key with it in Tipjai Studio."}
429 {"error":"rate_limited","message":"Too many requests. Retry after the number of seconds in Retry-After."}
503 {"error":"auth_unavailable","message":"Tipjai could not check this key right now. Retry in a moment."}ข้อความข้างบนอ่านจากโค้ดของ Tipjai ส่วนคำตอบจริงที่จับมาจาก tipjai.com อยู่ที่หัวข้อ GET /api/v1/me ซึ่ง endpoint นั้นใช้ข้อความ Send a valid key as Authorization: Bearer tj_live_... กับ 401 และ Retry in a moment. กับ 429 และ 503 ส่วนรหัส error เหมือนกัน
สถิติแพลตฟอร์ม
/api/v1/statsจำนวนครีเอเตอร์ที่สมัคร Tipjai แล้ว และที่นั่งช่วงเปิดตัวที่ยังเหลือ
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
creators | number | null | จำนวนครีเอเตอร์ที่สมัครแล้ว |
launch_cap | number | null | เพดานผู้สมัครช่วงเปิดตัว |
seats_remaining | number | null | ที่นั่งที่ยังเหลือ |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
429 | {"error":"rate_limited"} | เรียกเกิน 60 ครั้งต่อนาทีจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ คำตอบนี้ไม่ถูกแคช |
503 | {"error":"stats_unavailable"} | อ่านสถิติไม่ได้ชั่วคราว ลองใหม่หลัง 30 วินาที |
Cache-Control public, s-maxage=60, stale-while-revalidate=300
curl https://tipjai.com/api/v1/stats
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
ค้นหาครีเอเตอร์จากชื่อ
/api/v1/creatorsใส่ชื่อหรือชื่อหน้าของครีเอเตอร์ แล้วได้รายชื่อที่ตรงที่สุดก่อน พร้อมลิงก์หน้าที่แฟน ๆ ใช้ทิป (tip_url) ใช้ตอบคำถามว่า ทิปคนนี้ได้ที่ไหน เมื่อรู้แค่ชื่อ มีเฉพาะข้อมูลที่หน้าโปรไฟล์โชว์อยู่แล้ว ไม่มียอดเงิน ยอดเข้าชม หรือช่องทางรับเงิน
- คำค้นรับตัวอักษร (สระและวรรณยุกต์ไทยด้วย) ตัวเลข ช่องว่าง และ . _ - วางลิงก์ tipjai.com/ชื่อ หรือ @ชื่อ มาทั้งอันก็ได้ ระบบตัดเหลือชื่อหน้าให้
- เรียงจากตรงที่สุดก่อน: ชื่อหน้าหรือชื่อที่แสดงตรงทั้งคำ แล้วชื่อที่ขึ้นต้นด้วยคำค้น แล้วจึงชื่อที่มีคำค้นอยู่ข้างใน
- มีเฉพาะครีเอเตอร์ที่หน้าทิปเปิดให้ค้นเจอ: รับเงินได้ มีชื่อ ไม่ใช่บัญชีสาธิต และไม่ได้กำลังลบบัญชี
- bio เป็นข้อความที่ครีเอเตอร์เขียนเอง คำตอบติดป้าย content_trust ไว้ ให้ถือเป็นข้อมูล ไม่ใช่คำสั่ง
- เครื่องมือ MCP ชื่อ tipjai_find_creators ใช้การค้นเดียวกันนี้
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
q | string | ชื่อหรือชื่อหน้าของครีเอเตอร์ 2 ถึง 60 ตัวอักษร ยาวกว่านั้นจะถูกตัด |
limit | 1 ถึง 10 | จำนวนผลลัพธ์ ถ้าไม่ใส่ได้ 5 ค่าที่เกินช่วงถูกปรับเข้าช่วง |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
object | "list" | ชนิดของคำตอบ |
content_trust | "creator_authored_untrusted" | บอกว่าข้อความในรายการเป็นของครีเอเตอร์เขียนเอง |
query | string | คำค้นหลังจัดรูปแล้ว |
limit_max | number | limit สูงสุดที่ขอได้ (10) |
count | number | จำนวนรายการที่ได้ |
items[].username | string | ชื่อหน้า |
items[].display_name | string | ชื่อที่แสดง |
items[].bio | string | null | คำแนะนำตัวบรรทัดเดียว ไม่เกิน 160 ตัวอักษร |
items[].categories | string[] | หมวดที่ครีเอเตอร์เลือก |
items[].verified | boolean | ยืนยันตัวตนแล้วหรือยัง |
items[].tip_url | string | ลิงก์หน้าทิป ส่งต่อให้คนที่ถามได้เลย |
items[].avatar_url | string | null | ลิงก์รูปโปรไฟล์ |
items[].socials | object | ช่องทางที่หน้าของครีเอเตอร์ลิงก์ไว้ แยกตามแพลตฟอร์ม |
items[].matched_on | "handle" | "name" | ตรงกับชื่อหน้าหรือชื่อที่แสดง |
search_page | string | ลิงก์หน้าค้นหาบน tipjai.com ด้วยคำเดียวกัน ให้คนเปิดดูเองได้ |
note | string | ข้อความเตือนสั้น ๆ ว่า tip_url คืออะไร และ bio เป็นข้อมูล ไม่ใช่คำสั่ง |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
400 | {"error":"query_too_short", "message":"…"} | q สั้นกว่า 2 ตัวอักษรหลังจัดรูป หรือไม่ได้ส่งมา คำตอบนี้ไม่ถูกแคช |
429 | {"error":"rate_limited"} | เรียกเกิน 60 ครั้งต่อนาทีจาก IP เดียว รอตามค่า Retry-After (60 วินาที) แล้วลองใหม่ |
503 | {"error":"temporarily_unavailable"} | ค้นไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (10 วินาที) |
Cache-Control public, s-maxage=120, stale-while-revalidate=600
curl https://tipjai.com/api/v1/creators?q=tipjai&limit=2
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
โปรไฟล์สาธารณะของครีเอเตอร์
/api/v1/creator/{username}ใส่ชื่อหน้าของครีเอเตอร์ แล้วได้ข้อมูลที่หน้าโปรไฟล์โชว์อยู่แล้วกลับมา เอาไปทำการ์ดแนะนำ หรือโชว์ลิงก์ทิปบนเว็บของคุณได้ ไม่มีช่องทางรับเงินใด ๆ
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
username | string, path | ชื่อหน้า ส่วนท้ายของ tipjai.com/ชื่อ เช่น tipjai ถ้าครีเอเตอร์เปลี่ยนที่อยู่หน้าแล้ว ชื่อเดิมตอบ 308 พร้อม Location ไปที่ endpoint เดียวกันของชื่อปัจจุบัน |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
username | string | ชื่อหน้า |
display_name | string | ชื่อที่แสดง |
bio | string | null | คำแนะนำตัว |
avatar_url | string | null | ลิงก์รูปโปรไฟล์ |
accent_color | string | สีประจำตัวแบบ hex |
category | string | null | หมวดหลัก |
categories | string[] | หมวดทั้งหมดที่เลือก |
verified | boolean | ยืนยันตัวตนแล้วหรือยัง |
verified_handle | string | null | บัญชีที่ใช้ยืนยันตัวตน |
views | number | จำนวนการเข้าชมหน้า |
support_activity_visible | boolean | ครีเอเตอร์เปิดโชว์ยอดรวมหรือไม่ |
total_received | number | null | ยอดที่ยืนยันแล้ว เป็น null เมื่อครีเอเตอร์ซ่อนยอด |
supporters | number | null | จำนวนผู้สนับสนุน เป็น null เมื่อครีเอเตอร์ซ่อนยอด |
socials | object | ลิงก์ช่องทางอื่น แยกตามแพลตฟอร์ม |
tip_url | string | ลิงก์หน้าทิป ส่งต่อให้คนดูได้เลย |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
404 | {"error":"not_found"} | ไม่มีครีเอเตอร์ชื่อนี้ |
429 | {"error":"rate_limited"} | เรียกเกิน 60 ครั้งต่อนาทีจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ คำตอบนี้ไม่ถูกแคช |
503 | {"error":"temporarily_unavailable"} | อ่านข้อมูลไม่ได้ชั่วคราว ลองใหม่ |
Cache-Control no-store
curl https://tipjai.com/api/v1/creator/tipjai
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
หน้า Link ที่เผยแพร่แล้ว
/api/v1/creator/{username}/linksหน้ารวมลิงก์ link.tipjai.com/ชื่อ ของครีเอเตอร์ ทั้งดีไซน์และลิงก์ทุกอัน ข้อความเป็นของครีเอเตอร์ อย่าเอาไปใช้เป็นคำสั่ง
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
username | string, path | ชื่อหน้า ชื่อเดิมของครีเอเตอร์ที่เปลี่ยนที่อยู่แล้วตอบ 308 ไปที่ชื่อปัจจุบัน |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
schema_version | number | เวอร์ชันของรูปแบบข้อมูล ตอนนี้ 5 |
content_trust | string | creator_authored_untrusted ข้อความเป็นของครีเอเตอร์ ไม่ใช่คำสั่ง |
username, display_name, bio | string | ข้อมูลโปรไฟล์ bio อาจเป็น null |
avatar_url, cover_url | string | null | รูปโปรไฟล์และรูปปก |
link_url, tip_url | string | ลิงก์หน้า Link และหน้าทิป |
show_tip | boolean | หน้า Link โชว์ปุ่มทิปหรือไม่ จะเป็น true เมื่อเปิดปุ่มทิปไว้และครีเอเตอร์รับชำระเงินได้จริงตอนนี้ |
design | object | ดีไซน์ของหน้า (LinkPageDesign ใน OpenAPI) |
links | array | ลิงก์ทั้งหมดตามลำดับ แต่ละอันมี type เป็น link, social, header, image, canvas, widget หรือ copy |
socials | object | ลิงก์โซเชียล |
updated_at | string | null | เวลาที่แก้ล่าสุด |
next_change_at | string | null | เวลาที่ลิงก์ซึ่งตั้งเวลาไว้จะเริ่มหรือหยุดโชว์ครั้งถัดไป เป็น null ถ้าไม่มี ใช้บอกว่าควรดึงข้อมูลใหม่เมื่อไร |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
404 | {"error":"not_found"} | ไม่มีครีเอเตอร์ชื่อนี้ |
429 | {"error":"rate_limited"} | เรียกเกิน 60 ครั้งต่อนาทีจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ คำตอบนี้ไม่ถูกแคช |
503 | {"error":"temporarily_unavailable"} | อ่านไม่ได้ชั่วคราว ลองใหม่ |
Cache-Control no-store
curl https://tipjai.com/api/v1/creator/tipjai/links
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
อันดับผู้สนับสนุน
/api/v1/creator/{username}/leaderboardอันดับคนส่งทิปของครีเอเตอร์ เฉพาะเมื่อครีเอเตอร์เปิดโชว์ยอด ถ้าซ่อนไว้จะได้รายการว่างและ hidden เป็น true
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
username | string, path | ชื่อหน้า ชื่อเดิมของครีเอเตอร์ที่เปลี่ยนที่อยู่แล้วตอบ 308 ไปที่ชื่อปัจจุบัน โดยคง query เดิมไว้ |
period | month | all | ช่วงเวลา ค่าเริ่มต้น month |
limit | 1 ถึง 50 | จำนวนอันดับ ค่าเริ่มต้น 10 ใส่ทศนิยมจะถูกปัดลง |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
username | string | ชื่อหน้า |
period | string | month หรือ all |
hidden | boolean | true เมื่อครีเอเตอร์ซ่อนยอด |
count | number | จำนวนแถว |
leaderboard[].supporter | string | ชื่อที่คนส่งทิปใส่ |
leaderboard[].total | number | null | ยอดรวม |
leaderboard[].tips | number | จำนวนครั้ง |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
404 | {"error":"not_found"} | ไม่มีครีเอเตอร์ชื่อนี้ |
429 | {"error":"rate_limited"} | เรียกเกิน 60 ครั้งต่อนาทีจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ คำตอบนี้ไม่ถูกแคช |
503 | {"error":"unavailable"} | อ่านไม่ได้ชั่วคราว ลองใหม่หลัง 10 วินาที |
Cache-Control no-store
curl https://tipjai.com/api/v1/creator/tipjai/leaderboard?period=month&limit=10
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
ตลาดครีเอเตอร์
/api/v1/marketเฟรมรูปโปรไฟล์และสินค้าที่ครีเอเตอร์วางขายในตลาด Tipjai เฟรมฟรีขึ้นทุกอัน ส่วนเฟรมที่ขายและสินค้าจะขึ้นเฉพาะเมื่อผู้ขายคนนั้นรับชำระเงินได้จริงตอนนี้ ตามกติกาเดียวกับหน้าตลาดบน tipjai.com
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
count, frames[] | number, array | เฟรม: id, title, kind, colors, price, free, acquired, seller |
product_count, products[] | number, array | สินค้า: id, title, description, image, price, currency, product_type, fulfillment_type, fulfillment_eta_days, sold, seller |
total_count | number | เฟรมรวมกับสินค้า |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
429 | {"error":"rate_limited"} | เรียกเกิน 60 ครั้งต่อนาทีจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ คำตอบนี้ไม่ถูกแคช |
503 | {"error":"unavailable"} | อ่านรายการหรือข้อมูลผู้ขายไม่ได้ชั่วคราว ลองใหม่หลัง 10 วินาที คำตอบนี้ไม่ถูกแคช |
Cache-Control public, s-maxage=60, stale-while-revalidate=300
curl https://tipjai.com/api/v1/market
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
แม่แบบหน้า Link
/api/v1/link/templatesแม่แบบดีไซน์หน้า Link ทั้ง 20 แบบ พร้อมชื่อภาษาไทยและอังกฤษ
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
limit | 1 ถึง 50 | ค่าเริ่มต้น 20 |
offset | 0 ขึ้นไป | ค่าเริ่มต้น 0 |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
schema_version | number | 5 |
total, count, offset | number | ตัวนับสำหรับแบ่งหน้า |
has_more, next_offset | boolean, number | null | มีหน้าถัดไปไหม และเริ่มที่เท่าไร |
items[] | array | id, name_th, name_en, description_th, description_en, mood, design |
Cache-Control public, s-maxage=300, stale-while-revalidate=3600
curl https://tipjai.com/api/v1/link/templates?limit=2
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
แพลตฟอร์มที่รู้จัก
/api/v1/link/platformsรายชื่อแพลตฟอร์มที่หน้า Link รู้จัก พร้อมลิงก์ต้นแบบ
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
limit | 1 ถึง 50 | ค่าเริ่มต้น 20 |
offset | 0 ขึ้นไป | ค่าเริ่มต้น 0 |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
schema_version | number | 5 |
total, count, offset, has_more, next_offset | number, boolean | ตัวนับสำหรับแบ่งหน้า ตอนนี้มี 19 แพลตฟอร์ม |
items[] | array | key, label, icon_key, base_url, placeholder |
Cache-Control public, s-maxage=300, stale-while-revalidate=3600
curl https://tipjai.com/api/v1/link/platforms?limit=3
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
Playbook ที่มีแหล่งอ้างอิง
/api/v1/link/knowledgeคำแนะนำสำหรับครีเอเตอร์จากคลังที่ตรวจแล้ว ได้ผลเดิมทุกครั้งเมื่อถามเหมือนเดิม ไม่ค้นเว็บสด และไม่มีข้อมูลบัญชีครีเอเตอร์
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
prompt | string, ไม่เกิน 500 | คำถาม |
category | string | ซ้ำหรือคั่นด้วยจุลภาคได้ ไม่เกิน 3 |
platform | string | ซ้ำหรือคั่นด้วยจุลภาคได้ ไม่เกิน 12 |
topic | enum | tipjai-boundaries, link-architecture, accessibility, youtube, line, creator-playbook |
limit | 1 ถึง 12 | ค่าเริ่มต้น 6 |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
schema_version, knowledge_version | number, string | เวอร์ชันของรูปแบบข้อมูลและของคลังความรู้ |
count, items[] | number, array | คำแนะนำพร้อมแหล่งอ้างอิง |
Cache-Control public, s-maxage=300, stale-while-revalidate=3600
curl https://tipjai.com/api/v1/link/knowledge?topic=link-architecture&limit=2
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
JSON Schema
/api/v1/link/schemaSchema ของ draft หน้า Link และข้อมูลที่ได้หลังตรวจ ใช้ตรวจข้อมูลฝั่งคุณก่อนส่ง เวอร์ชัน 5 เพิ่มบล็อกคัดลอกข้อความ (copy) ส่วนเวอร์ชัน 4 เพิ่ม identity tokens และวิดเจ็ตที่โหลดหลังผู้ชมยินยอม
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
schema_version | number | 5 |
draft_input | JSON Schema | รูปแบบ draft ที่ส่งเข้า validate |
design_output, link_output | JSON Schema | รูปแบบที่ได้กลับมา |
Cache-Control public, s-maxage=300, stale-while-revalidate=3600
curl https://tipjai.com/api/v1/link/schema
กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
ตรวจ draft หน้า Link
/api/v1/link/validateส่ง draft เข้าไป ได้ draft ที่จัดรูปแล้วกับรายการปัญหากลับมา ตรวจอย่างเดียว บันทึก เผยแพร่ ลบ หรือแก้ช่องทางรับเงินไม่ได้
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
body | application/json, ไม่เกิน 128 KB | links (จำเป็น, ไม่เกิน 40) และ design ลิงก์แต่ละอันมี type: link, social, header, image, canvas, widget หรือ copy |
links[] (type "copy") | object | บล็อกข้อความที่ผู้ชมแตะครั้งเดียวก็คัดลอก ต้องมี label และ copy_text (ข้อความบรรทัดเดียว ไม่เกิน 120 ตัวอักษร ห้ามมี :// ถ้าเป็นที่อยู่เว็บให้ใช้ลิงก์ปกติ) icon เป็นคีย์แพลตฟอร์มหรือ null ใส่ได้ไม่เกิน 6 บล็อกต่อหน้า ถ้ายาวเกิน 120 ตัวอักษร หรือไม่มี label หรือ copy_text จะได้ 400 invalid_draft บอกตำแหน่ง ถ้ามี :// จะได้ invalid_copy ถ้าเกิน 6 บล็อกจะได้ copy_limit ตัวอย่าง: {"type":"copy","label":"LINE ID","copy_text":"@tipjai"} |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
schema_version | number | 5 |
valid | boolean | ผ่านทั้งหมดหรือไม่ |
design, links | object, array | draft ที่จัดรูปแล้ว |
issues, warnings | array | ปัญหาที่ต้องแก้ แต่ละอันมี index กับ code ซึ่งเป็นหนึ่งใน 11 รหัส: invalid_url, invalid_media, invalid_canvas, invalid_widget, invalid_copy, missing_label, limit, media_limit, canvas_limit, widget_limit, copy_limit ส่วนคำเตือนมีรหัส multiple_highlights_normalized |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
400 | {"error":"invalid_draft", …} | รูปแบบไม่ถูก พร้อม issues บอกตำแหน่ง |
413 | too large | body เกิน 128 KB |
415 | wrong type | Content-Type ต้องเป็น application/json |
429 | {"error":"rate_limited"} | เรียกเกิน 60 ครั้งต่อนาทีจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ คำตอบนี้ไม่ถูกแคช |
Cache-Control no-store
curl -X POST https://tipjai.com/api/v1/link/validate \
-H "Content-Type: application/json" \
-d '{"links":[{"type":"link","label":"ช่อง YouTube","url":"https://youtube.com/@tipjai"}]}'กด ส่งคำขอจริง แล้วคำตอบสดพร้อมสถานะจะขึ้นตรงนี้
คีย์นี้เป็นของใคร
/api/v1/meสิทธิ์ที่ต้องมี ไม่ต้องมี คีย์ที่ใช้งานได้ทุกอันเรียกได้
ถามว่าคีย์ที่ส่งมาเป็นของครีเอเตอร์คนไหนและมีสิทธิ์อะไรบ้าง คีย์ที่ใช้งานได้ทุกอันเรียกได้ ไม่ต้องมีสิทธิ์เพิ่ม ใช้เช็กว่าตั้งคีย์ถูกก่อนเรียก endpoint อื่น
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
creator.username, creator.display_name | string | ชื่อหน้าและชื่อที่แสดงของเจ้าของคีย์ |
key.id | string (uuid) | รหัสของคีย์นี้ ไม่ใช่ตัวคีย์ |
key.scopes | string[] | สิทธิ์ที่คีย์นี้มี เช่น tips:read |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
401 | {"error":"missing_api_key"} | ไม่ได้ส่ง Authorization: Bearer tj_live_... (ค่าที่ไม่ขึ้นต้นด้วย tj_live_ ถือว่าไม่ได้ส่งคีย์) |
401 | {"error":"invalid_api_key"} | คีย์ไม่ถูกต้องหรือถูกยกเลิกแล้ว สร้างใหม่ใน Studio |
429 | {"error":"rate_limited"} | เรียกเกิน 120 ครั้งต่อนาทีต่อคีย์ หรือเรียกถี่เกินไปจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ |
503 | {"error":"auth_unavailable"} | ตรวจคีย์ไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
503 | {"error":"unavailable"} | อ่านข้อมูลของคุณไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
Cache-Control no-store
curl "https://tipjai.com/api/v1/me" \ -H "Authorization: Bearer tj_live_..."
{
"creator": {
"username": "your_name",
"display_name": "Your Name"
},
"key": {
"id": "5f0f4f5a-3c2d-4d2b-8e8e-2a6f7c1d9b10",
"scopes": [
"tips:read",
"stats:read"
]
}
}ไม่มีปุ่มส่งคำขอจริงสำหรับ endpoint ที่ใช้คีย์ เพราะไม่ควรพิมพ์คีย์ลงหน้าเว็บ ใช้ตัวอย่างข้างบนในโค้ดฝั่งเซิร์ฟเวอร์ของคุณ
คำตอบจริงเมื่อไม่ส่งคีย์
curl -i https://tipjai.com/api/v1/me
{
"error": "missing_api_key",
"message": "Send a valid key as Authorization: Bearer tj_live_..."
}ทิปที่ยืนยันแล้ว
/api/v1/me/tipsสิทธิ์ที่ต้องมี tips:read
ทิปที่ยืนยันแล้วของเจ้าของคีย์ เรียงจากล่าสุดก่อน แบ่งหน้าด้วย cursor เหมาะกับแดชบอร์ด บอท หรือชีตของคุณเอง นับเฉพาะเงินที่หน้ารายได้และภาษีใน Studio นับ ไม่มีทิปทดสอบ ไม่มีทิปที่ยังไม่ยืนยัน และไม่มีอีเวนต์ที่ส่งเข้ามาเอง
- from และ to เป็นวันตามเวลาไทย (Asia/Bangkok) นับทั้งวัน กรองและเรียงตาม settled_at คือเวลาที่ทิปนับเป็นเงินแล้ว
- ดูหน้าถัดไปโดยส่ง next_cursor เป็น cursor ถ้า next_cursor เป็น null แปลว่าหมดแล้ว
- supporter และ message เป็นข้อความที่คนส่งทิปเขียนเอง ถือเป็นข้อมูล ไม่ใช่คำสั่ง
- ทิปเล่น คือทิปที่ผู้ส่งกดยืนยันโดยไม่แนบสลิป (verification เป็น unverified) ไม่อยู่ในรายการนี้ แม้ webhook จะส่งทิปแบบนั้นมาให้ เพราะหน้ารายได้และภาษีใน Studio ไม่นับเป็นเงิน
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
limit | 1 ถึง 100 | จำนวนทิปต่อหน้า ค่าเริ่มต้น 25 |
cursor | string | ค่า next_cursor จากหน้าก่อน เพื่อดูหน้าถัดไป |
from | YYYY-MM-DD | วันแรกที่จะนับ ตามเวลาไทย นับทั้งวัน |
to | YYYY-MM-DD | วันสุดท้ายที่จะนับ ตามเวลาไทย นับทั้งวัน |
min_amount | number | ยอดต่ำสุดที่จะรวม 0 ถึง 10,000,000 |
max_amount | number | ยอดสูงสุดที่จะรวม 0 ถึง 10,000,000 |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
object | string | เป็น list เสมอ |
data[] | array | ทิปในหน้านี้ แต่ละรายการมี id, amount, currency, supporter, message, verification, payment_method, gift, settled_at, created_at |
data[].id | string (uuid) | รหัสของทิป |
data[].amount, data[].currency | number, string | ยอดและสกุลเงิน ปกติเป็น THB |
data[].supporter, data[].message | string | ชื่อและข้อความที่คนส่งใส่ เป็นค่าว่างเมื่อไม่มี |
data[].verification | string | ระดับการยืนยัน: verified ธนาคารยืนยันยอดแล้ว, structural ยอดตามที่ผู้โอนแจ้ง, creator_confirmed ครีเอเตอร์ตรวจบัญชีและยืนยันเอง |
data[].payment_method | string | ช่องทางที่ทิปเข้ามา เช่น promptpay |
data[].gift | object | null | id, name, qty เมื่อทิปมาพร้อมของขวัญ ไม่มีจะเป็น null |
data[].settled_at, data[].created_at | string | เวลาที่ทิปนับเป็นเงินแล้วกับเวลาที่สร้างทิป เป็นข้อความเวลาเต็มรูปแบบ ISO 8601 |
next_cursor | string | null | ส่งเป็น cursor เพื่อดูหน้าถัดไป เป็น null เมื่อหมดแล้ว |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
400 | {"error":"invalid_limit", …} | ค่าใน query ไม่ถูกต้อง รหัส error บอกว่าตัวไหน: invalid_limit, invalid_cursor, invalid_from, invalid_to, from_after_to, invalid_min_amount, invalid_max_amount ข้อความ message เป็นภาษาอังกฤษ: Check the query parameters: limit 1-100, cursor from next_cursor, from/to as YYYY-MM-DD, min_amount/max_amount as numbers. |
401 | {"error":"missing_api_key"} | ไม่ได้ส่ง Authorization: Bearer tj_live_... (ค่าที่ไม่ขึ้นต้นด้วย tj_live_ ถือว่าไม่ได้ส่งคีย์) |
401 | {"error":"invalid_api_key"} | คีย์ไม่ถูกต้องหรือถูกยกเลิกแล้ว สร้างใหม่ใน Studio |
403 | {"error":"insufficient_scope"} | คีย์นี้ไม่มีสิทธิ์ tips:read สร้างคีย์ที่มีสิทธิ์นี้ใน Studio |
429 | {"error":"rate_limited"} | เรียกเกิน 120 ครั้งต่อนาทีต่อคีย์ หรือเรียกถี่เกินไปจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ |
503 | {"error":"auth_unavailable"} | ตรวจคีย์ไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
503 | {"error":"unavailable"} | อ่านข้อมูลของคุณไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
Cache-Control no-store
curl "https://tipjai.com/api/v1/me/tips?limit=2" \ -H "Authorization: Bearer tj_live_..."
{
"object": "list",
"data": [
{
"id": "2d7c1d0e-6a5b-4a38-9f60-1c3b8e4a7d12",
"amount": 100,
"currency": "THB",
"supporter": "มะลิ",
"message": "สู้ ๆ",
"verification": "verified",
"payment_method": "promptpay",
"gift": null,
"settled_at": "2026-10-21T13:00:00.123456+00:00",
"created_at": "2026-10-21T12:59:41.502113+00:00"
},
{
"id": "9a4e6b21-0f3c-4d57-a1b8-7e2d5c9f3a60",
"amount": 30,
"currency": "THB",
"supporter": "ต้นไม้",
"message": "ขอบคุณครับ",
"verification": "creator_confirmed",
"payment_method": "promptpay",
"gift": { "id": "rose", "name": "กุหลาบ", "qty": 3 },
"settled_at": "2026-10-21T11:42:10.804512+00:00",
"created_at": "2026-10-21T11:41:55.017834+00:00"
}
],
"next_cursor": "MjAyNi0xMC0yMVQxMTo0MjoxMC44MDQ1MTIrMDA6MDB8OWE0ZTZiMjEtMGYzYy00ZDU3LWExYjgtN2UyZDVjOWYzYTYw"
}ไม่มีปุ่มส่งคำขอจริงสำหรับ endpoint ที่ใช้คีย์ เพราะไม่ควรพิมพ์คีย์ลงหน้าเว็บ ใช้ตัวอย่างข้างบนในโค้ดฝั่งเซิร์ฟเวอร์ของคุณ
ยอดรวมรายวัน
/api/v1/me/statsสิทธิ์ที่ต้องมี stats:read
ยอดรวมของทิปที่ยืนยันแล้วแยกตามวัน (เวลาไทย) พร้อมผลรวมทั้งช่วง เหมาะกับกราฟหรือสรุปรายเดือน ใช้กติกานับเงินเดียวกับหน้ารายได้และภาษีใน Studio
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
from | YYYY-MM-DD | วันแรกที่จะนับ ตามเวลาไทย ถ้าไม่ใส่จะเริ่มก่อนวันสุดท้าย 29 วัน (รวม 30 วัน) |
to | YYYY-MM-DD | วันสุดท้ายที่จะนับ ตามเวลาไทย ถ้าไม่ใส่จะเป็นวันนี้ ช่วง from ถึง to ยาวได้ไม่เกิน 366 วัน |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
from, to, time_zone, currency | string | ช่วงที่ขอ (วันตามเวลาไทย) เขตเวลา Asia/Bangkok และสกุลเงิน THB |
totals | object | ผลรวมทั้งช่วง: tips (จำนวนทิป), total (ยอดรวม), verified_total, structural_total, creator_confirmed_total (ยอดแยกตามระดับการยืนยัน) |
days[] | array | แต่ละวันที่มีเงินเข้า เรียงจากวันเก่าไปใหม่ วันที่ไม่มีเงินจะไม่อยู่ในรายการ |
days[].date | string | วัน YYYY-MM-DD ตามเวลาไทย |
days[].tips, days[].supporters | number | จำนวนทิป และจำนวนชื่อผู้สนับสนุนที่ต่างกันในวันนั้น ทิปที่ไม่ใส่ชื่อไม่นับในจำนวนชื่อ |
days[].total, days[].verified_total, days[].structural_total, days[].creator_confirmed_total | number | ยอดรวมของวัน และยอดแยกตามระดับการยืนยัน |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
400 | {"error":"invalid_from", …} | วันที่ไม่ถูกต้อง รหัส error บอกว่าตัวไหน: invalid_from, invalid_to, from_after_to (from อยู่หลัง to), range_too_long (เกิน 366 วัน) ข้อความ message เป็นภาษาอังกฤษ |
401 | {"error":"missing_api_key"} | ไม่ได้ส่ง Authorization: Bearer tj_live_... (ค่าที่ไม่ขึ้นต้นด้วย tj_live_ ถือว่าไม่ได้ส่งคีย์) |
401 | {"error":"invalid_api_key"} | คีย์ไม่ถูกต้องหรือถูกยกเลิกแล้ว สร้างใหม่ใน Studio |
403 | {"error":"insufficient_scope"} | คีย์นี้ไม่มีสิทธิ์ stats:read สร้างคีย์ที่มีสิทธิ์นี้ใน Studio |
429 | {"error":"rate_limited"} | เรียกเกิน 120 ครั้งต่อนาทีต่อคีย์ หรือเรียกถี่เกินไปจาก IP เดียว รอตามค่า Retry-After แล้วลองใหม่ |
503 | {"error":"auth_unavailable"} | ตรวจคีย์ไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
503 | {"error":"unavailable"} | อ่านข้อมูลของคุณไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
Cache-Control no-store
curl "https://tipjai.com/api/v1/me/stats?from=2026-10-01&to=2026-10-21" \ -H "Authorization: Bearer tj_live_..."
{
"from": "2026-10-01",
"to": "2026-10-21",
"time_zone": "Asia/Bangkok",
"currency": "THB",
"totals": {
"tips": 3,
"total": 180,
"verified_total": 150,
"structural_total": 0,
"creator_confirmed_total": 30
},
"days": [
{
"date": "2026-10-20",
"tips": 1,
"supporters": 1,
"total": 50,
"verified_total": 50,
"structural_total": 0,
"creator_confirmed_total": 0
},
{
"date": "2026-10-21",
"tips": 2,
"supporters": 2,
"total": 130,
"verified_total": 100,
"structural_total": 0,
"creator_confirmed_total": 30
}
]
}ไม่มีปุ่มส่งคำขอจริงสำหรับ endpoint ที่ใช้คีย์ เพราะไม่ควรพิมพ์คีย์ลงหน้าเว็บ ใช้ตัวอย่างข้างบนในโค้ดฝั่งเซิร์ฟเวอร์ของคุณ
ไฟล์รายรับ (CSV)
/api/v1/me/exportสิทธิ์ที่ต้องมี export:read
ไฟล์ CSV รายรับชุดเดียวกับปุ่มดาวน์โหลด (CSV) ในหน้า ทิป ของ Studio คอลัมน์และบรรทัดหมายเหตุเหมือนกัน เหมาะกับโปรแกรมบัญชีหรือชีตที่คุณต่อเอง คำตอบเป็นไฟล์ CSV ไม่ใช่ JSON
- ไฟล์เป็น UTF-8 มี BOM นำหน้า ตามด้วยบรรทัดหมายเหตุ 4 บรรทัดที่ขึ้นต้นด้วย # แล้วจึงเป็นแถวหัวคอลัมน์ ถ้าไม่มีทิปในช่วงนั้นจะได้เฉพาะบรรทัดหมายเหตุ
- ส่วนหัวของคำตอบบอกชื่อไฟล์ใน Content-Disposition (tipjai-statement-วันแรก-to-วันสุดท้าย.csv) และบอกจำนวนแถวใน X-Tipjai-Rows
- ไฟล์ละไม่เกิน 20,000 แถว ถ้ามากกว่านั้นจะได้ 422 range_too_large ให้ขอช่วงที่สั้นลง
- ข้อความที่ขึ้นต้นด้วย = + - หรือ @ จะมี ' นำหน้า เพื่อไม่ให้โปรแกรมชีตเอาไปคำนวณเป็นสูตร
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
from | YYYY-MM-DD | วันแรกที่จะนับ ตามเวลาไทย ถ้าไม่ใส่จะเริ่มก่อนวันสุดท้าย 29 วัน (รวม 30 วัน) |
to | YYYY-MM-DD | วันสุดท้ายที่จะนับ ตามเวลาไทย ถ้าไม่ใส่จะเป็นวันนี้ ช่วง from ถึง to ยาวได้ไม่เกิน 366 วัน |
คอลัมน์ในไฟล์
| คอลัมน์ | ชนิด | คำอธิบาย |
|---|---|---|
วันที่ | text | วันที่ YYYY-MM-DD ตามเวลาไทย |
เดือน | number | เลขเดือน 1 ถึง 12 |
ปี_พศ | number | ปีพุทธศักราช |
ปี_คศ | number | ปีคริสต์ศักราช |
ผู้สนับสนุน | text | ชื่อที่คนส่งใส่ |
ยอดรับ_บาท | number | ยอดที่ได้รับ |
ค่าธรรมเนียมแพลตฟอร์ม_บาท | number | เป็น 0 เสมอ Tipjai ไม่หักค่าธรรมเนียมทิป |
ค่าธรรมเนียมผู้ให้บริการชำระเงิน_บาท | number, blank | เป็น 0 หรือว่าง ว่างเมื่อทิปมาทางบัตร เพราะผู้ให้บริการชำระเงินบัตรหักค่าธรรมเนียมของเขาเอง และ Tipjai ไม่ทราบยอดนั้น |
สุทธิ_บาท | number, blank | ยอดสุทธิ ว่างเมื่อทิปมาทางบัตร |
ช่องทาง | text | ช่องทางที่ทิปเข้ามา เช่น promptpay |
การยืนยัน | text | verified, structural หรือ creator_confirmed |
ยอดยืนยันกับธนาคาร | text | ใช่ เมื่อธนาคารยืนยันยอด นอกนั้นเป็นข้อความบอกว่ายอดเป็นไปตามที่ผู้โอนแจ้ง หรือครีเอเตอร์ตรวจบัญชีและยืนยัน |
ข้อความ | text | ข้อความจากคนส่ง |
ของขวัญ | text | ชื่อของขวัญ ว่างเมื่อไม่มี |
รางวัลที่สัญญา | text | สิ่งที่ครีเอเตอร์สัญญาไว้กับของขวัญนั้น ว่างเมื่อไม่มี |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
400 | {"error":"invalid_from", …} | วันที่ไม่ถูกต้อง รหัส error บอกว่าตัวไหน: invalid_from, invalid_to, from_after_to (from อยู่หลัง to), range_too_long (เกิน 366 วัน) ข้อความ message เป็นภาษาอังกฤษ |
422 | {"error":"range_too_large"} | มีทิปเกิน 20,000 รายการในช่วงนี้ ขอช่วงที่สั้นลง |
401 | {"error":"missing_api_key"} | ไม่ได้ส่ง Authorization: Bearer tj_live_... (ค่าที่ไม่ขึ้นต้นด้วย tj_live_ ถือว่าไม่ได้ส่งคีย์) |
401 | {"error":"invalid_api_key"} | คีย์ไม่ถูกต้องหรือถูกยกเลิกแล้ว สร้างใหม่ใน Studio |
403 | {"error":"insufficient_scope"} | คีย์นี้ไม่มีสิทธิ์ export:read สร้างคีย์ที่มีสิทธิ์นี้ใน Studio |
429 | {"error":"rate_limited"} | เรียกเกิน 120 ครั้งต่อนาทีต่อคีย์ เรียกถี่เกินไปจาก IP เดียว หรือขอไฟล์เกิน 10 ไฟล์ต่อนาทีต่อครีเอเตอร์ รอตามค่า Retry-After แล้วลองใหม่ |
503 | {"error":"auth_unavailable"} | ตรวจคีย์ไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
503 | {"error":"unavailable"} | อ่านข้อมูลของคุณไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
Cache-Control no-store
curl "https://tipjai.com/api/v1/me/export?from=2026-10-01&to=2026-10-21" \ -H "Authorization: Bearer tj_live_..." \ -o tipjai-statement.csv
# สรุปรายรับจาก Tipjai ซึ่งไม่หักค่าธรรมเนียม (เงินโอนตรงจากผู้ให้ทิปถึงคุณ) # … (อีก 3 บรรทัดหมายเหตุ ขึ้นต้นด้วย # เหมือนกัน) วันที่,เดือน,ปี_พศ,ปี_คศ,ผู้สนับสนุน,ยอดรับ_บาท,ค่าธรรมเนียมแพลตฟอร์ม_บาท,ค่าธรรมเนียมผู้ให้บริการชำระเงิน_บาท,สุทธิ_บาท,ช่องทาง,การยืนยัน,ยอดยืนยันกับธนาคาร,ข้อความ,ของขวัญ,รางวัลที่สัญญา 2026-10-21,10,2569,2026,มะลิ,100,0,0,100,promptpay,verified,ใช่,สู้ ๆ,, 2026-10-21,10,2569,2026,ต้นไม้,30,0,0,30,promptpay,creator_confirmed,ไม่ (ครีเอเตอร์ตรวจบัญชีและยืนยัน),ขอบคุณครับ,กุหลาบ, 2026-10-20,10,2569,2026,ฟ้า,50,0,0,50,promptpay,verified,ใช่,เป็นกำลังใจให้,,
ไม่มีปุ่มส่งคำขอจริงสำหรับ endpoint ที่ใช้คีย์ เพราะไม่ควรพิมพ์คีย์ลงหน้าเว็บ ใช้ตัวอย่างข้างบนในโค้ดฝั่งเซิร์ฟเวอร์ของคุณ
ส่งอีเวนต์ขึ้นจอ
/api/v1/me/eventsสิทธิ์ที่ต้องมี events:write
ให้เครื่องมือของคุณส่งอีเวนต์จากแพลตฟอร์มอื่น เช่น ของขวัญบน YouTube หรือคนกดติดตามบน Kick ขึ้นการ์ดในกล่องแจ้งเตือนเดียวกับทิป อีเวนต์ไม่ใช่เงินเสมอ และไม่เข้ายอดใดเลย
- ใช้สวิตช์ชุดเดียวกับแจ้งเตือน TikTok ในหน้า แจ้งเตือนและวิดเจ็ต หัวข้อ แจ้งเตือนจาก TikTok LIVE ต้องติ๊ก แสดงแจ้งเตือนจาก TikTok บนจอนี้ ไว้ (เปิดอยู่ตั้งแต่แรก) ถ้าจะส่งคนกดติดตามหรือคนแชร์ ต้องติ๊ก แสดงคนกดติดตาม หรือ แสดงคนแชร์ไลฟ์ ด้วย (สองอย่างนี้ปิดอยู่ตั้งแต่แรก)
- อีเวนต์ไม่ใช่เงินเสมอ ไม่เข้ายอดรวม เป้า อันดับ นาฬิกาซับบาธอน รายรับ ภาษี หรือ webhook ถ้า body มีฟิลด์ amount, value, price, currency, diamonds, coins, baht, total หรือ money (ทั้งชั้นนอกและใน gift) จะถูกปฏิเสธด้วย 422
- ครั้งแรกตอบ 201 ถ้าส่งซ้ำด้วย Idempotency-Key เดิมภายใน 7 วัน จะได้ 200 พร้อมผลลัพธ์แรกและส่วนหัว Idempotent-Replayed: true และไม่ขึ้นจอซ้ำ ถ้าคำขอครั้งแรกยังไม่เสร็จ การส่งซ้ำจะได้ 409 ถ้าคำขอครั้งแรกหยุดไปก่อนเก็บผล หลังผ่านไปราว 1 นาที การส่งซ้ำจะขึ้นจอให้ครั้งเดียว
- ตัวกรองคำหยาบของครีเอเตอร์ใช้กับชื่อที่ขึ้นบนการ์ดด้วย คำที่ถูกกรองจะถูกบัง
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
Idempotency-Key | header, จำเป็น | 1 ถึง 120 ตัวอักษร ใช้ A-Z a-z 0-9 _ . : - เช่น id ของอีเวนต์บนแพลตฟอร์มต้นทาง |
body | application/json, ไม่เกิน 4 KB | JSON object เดียว: type, name, source (ไม่บังคับ), gift (เฉพาะ gift) ฟิลด์ที่ไม่รู้จักจะถูกปฏิเสธ |
type | enum | ประเภทอีเวนต์ ใช้ได้ gift, follow, share หรือ sub |
name | string | ชื่อผู้ชมที่ขึ้นบนการ์ด ไม่เกิน 40 ตัวอักษร ส่วนที่เกินถูกตัด |
source | string | ไม่บังคับ ป้ายสั้น ๆ บอกที่มา เช่น YouTube ไม่เกิน 24 ตัวอักษร ขึ้นใต้การ์ด |
gift | object | จำเป็นเมื่อ type เป็น gift: gift.name ไม่เกิน 32 ตัวอักษร และ gift.count จำนวนเต็ม 1 ถึง 99,999 (ไม่ใส่จะเป็น 1) ประเภทอื่นห้ามส่ง gift |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
id | string (uuid) | รหัสของอีเวนต์ที่รับไว้ |
object | string | เป็น event เสมอ |
type | string | gift, follow, share หรือ sub ตามที่ส่ง |
shown | boolean | true เมื่อส่งไปที่จอแจ้งเตือนของคุณแล้ว |
reason | string | null | เป็น null เมื่อ shown เป็น true ถ้าไม่ใช่จะบอกสาเหตุ: platform_alerts_off (ปิดแจ้งเตือนไว้), hidden_by_settings (ประเภทนั้นยังปิดอยู่ เช่นคนกดติดตาม), overlay_unreachable (ส่งไปที่จอไม่สำเร็จ) |
counted_as_money | boolean | เป็น false เสมอ |
received_at | string | เวลาที่ Tipjai รับอีเวนต์ แบบ ISO 8601 |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
400 | {"error":"idempotency_key_required", …} | ไม่มีส่วนหัว Idempotency-Key หรือรูปแบบไม่ถูก |
400 | {"error":"unknown_field", …} | body ไม่ถูกต้อง รหัส error บอกว่าตัวไหน: invalid_body (ไม่ใช่ JSON object หรือเกิน 4 KB), unknown_field, invalid_type, invalid_name, invalid_source, invalid_gift, invalid_event ข้อความ message เป็นภาษาอังกฤษ |
409 | {"error":"in_progress"} | อีเวนต์ที่ใช้ Idempotency-Key นี้ยังประมวลผลอยู่ ส่งซ้ำด้วยคีย์เดิมหลัง Retry-After (2 วินาที) |
422 | {"error":"events_are_never_money"} | ส่งฟิลด์ที่ดูเป็นเงิน อีเวนต์ไม่ใช่เงินเสมอ ข้อความ message บอกชื่อฟิลด์ที่ถูกปฏิเสธ |
422 | {"error":"idempotency_key_reused"} | ใช้ Idempotency-Key เดิมกับอีเวนต์อื่น ใช้คีย์ใหม่สำหรับอีเวนต์ใหม่ |
401 | {"error":"missing_api_key"} | ไม่ได้ส่ง Authorization: Bearer tj_live_... (ค่าที่ไม่ขึ้นต้นด้วย tj_live_ ถือว่าไม่ได้ส่งคีย์) |
401 | {"error":"invalid_api_key"} | คีย์ไม่ถูกต้องหรือถูกยกเลิกแล้ว สร้างใหม่ใน Studio |
403 | {"error":"insufficient_scope"} | คีย์นี้ไม่มีสิทธิ์ events:write สร้างคีย์ที่มีสิทธิ์นี้ใน Studio |
429 | {"error":"rate_limited"} | เรียกเกิน 120 ครั้งต่อนาทีต่อคีย์ เรียกถี่เกินไปจาก IP เดียว หรือส่งเกิน 60 อีเวนต์ต่อนาทีต่อครีเอเตอร์ รอตามค่า Retry-After แล้วลองใหม่ ส่งซ้ำด้วย Idempotency-Key เดิมได้ |
503 | {"error":"auth_unavailable"} | ตรวจคีย์ไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
503 | {"error":"unavailable"} | บันทึกอีเวนต์ไม่ได้ชั่วคราว ส่งซ้ำด้วย Idempotency-Key เดิมหลัง Retry-After (5 วินาที) |
Cache-Control no-store
curl -X POST "https://tipjai.com/api/v1/me/events" \
-H "Authorization: Bearer tj_live_..." \
-H "Idempotency-Key: yt-gift-8812" \
-H "Content-Type: application/json" \
-d '{"type":"gift","name":"มะลิ","source":"YouTube","gift":{"name":"Super Sticker","count":1}}'{
"id": "6c1f0d3a-8b2e-4f57-9a1c-5d7e2b4f8a39",
"object": "event",
"type": "gift",
"shown": true,
"reason": null,
"counted_as_money": false,
"received_at": "2026-10-27T13:05:12.481Z"
}ไม่มีปุ่มส่งคำขอจริงสำหรับ endpoint ที่ใช้คีย์ เพราะไม่ควรพิมพ์คีย์ลงหน้าเว็บ ใช้ตัวอย่างข้างบนในโค้ดฝั่งเซิร์ฟเวอร์ของคุณ
คุมนาฬิกาซับบาธอน
/api/v1/me/timerสิทธิ์ที่ต้องมี timer:write
เพิ่ม ลด หยุด หรือเดินต่อนาฬิกาซับบาธอนบนสตรีม เหมือนปุ่มใน Studio ทุกอย่างผ่านทางเดียวกับปุ่มเหล่านั้น OBS และหน้าสาธารณะจะอ่านค่าใหม่เอง
- add และ subtract ขยับได้ครั้งละไม่เกิน 604,800 วินาที (1 สัปดาห์)
- ถ้าวิดเจ็ตนาฬิกาของคุณไม่ได้อยู่ในโหมดจับเวลา (timer_mode เป็น false) ค่าที่เปลี่ยนจะถูกบันทึกไว้ แต่ยังไม่มีอะไรแสดงมัน
- ส่งได้ 30 คำสั่งต่อนาทีต่อครีเอเตอร์ นับรวมทาง REST และทาง MCP
พารามิเตอร์
| ชื่อ | ชนิด | คำอธิบาย |
|---|---|---|
body | application/json, ไม่เกิน 1 KB | JSON object เดียว: action และ seconds หรือ minutes ฟิลด์ที่ไม่รู้จักจะถูกปฏิเสธ |
action | enum | add (เพิ่ม), subtract (ลด), pause (หยุด) หรือ resume (เดินต่อ) |
seconds | 1 ถึง 604800 | จำเป็นกับ add และ subtract เป็นจำนวนวินาทีเต็ม pause และ resume ห้ามส่ง |
minutes | number | ใช้แทน seconds ได้ (1 นาที = 60 วินาที) ส่งอย่างใดอย่างหนึ่ง ห้ามส่งทั้งสอง |
สิ่งที่ได้กลับมา
| ฟิลด์ | ชนิด | คำอธิบาย |
|---|---|---|
action | string | คำสั่งที่ส่ง |
running | boolean | true เมื่อนาฬิกากำลังเดิน false เมื่อหยุดอยู่ |
shows_seconds | number | ค่าที่สตรีมแสดงหลังคำสั่งนี้ เป็นวินาทีเต็ม (นาฬิกาฐานบวกเวลาที่ทิปในรอบนี้เพิ่มให้) |
timer_ends_at | string | null | เวลาที่นาฬิกาฐานจะหมด เป็น null ขณะหยุด |
paused_seconds | number | วินาทีที่นาฬิกาฐานเก็บไว้ขณะหยุด |
timer_mode | boolean | false เมื่อวิดเจ็ตนาฬิกาของคุณไม่ได้อยู่ในโหมดจับเวลา ค่าถูกบันทึกแล้ว แต่ยังไม่มีอะไรแสดงมัน |
เมื่อไม่สำเร็จ
| สถานะ | body | ความหมาย |
|---|---|---|
400 | {"error":"invalid_timer_command", …} | คำสั่งไม่ถูกต้อง เช่น action ไม่ใช่ add, subtract, pause หรือ resume, add หรือ subtract ไม่มี seconds, pause หรือ resume ส่ง seconds, ส่งทั้ง seconds และ minutes หรือมีฟิลด์ที่ไม่รู้จัก ข้อความ message บอกว่าตัวไหน เป็นภาษาอังกฤษ |
404 | {"error":"creator_not_found"} | ไม่พบหน้าครีเอเตอร์ของคีย์นี้ |
401 | {"error":"missing_api_key"} | ไม่ได้ส่ง Authorization: Bearer tj_live_... (ค่าที่ไม่ขึ้นต้นด้วย tj_live_ ถือว่าไม่ได้ส่งคีย์) |
401 | {"error":"invalid_api_key"} | คีย์ไม่ถูกต้องหรือถูกยกเลิกแล้ว สร้างใหม่ใน Studio |
403 | {"error":"insufficient_scope"} | คีย์นี้ไม่มีสิทธิ์ timer:write สร้างคีย์ที่มีสิทธิ์นี้ใน Studio |
429 | {"error":"rate_limited"} | เรียกเกิน 120 ครั้งต่อนาทีต่อคีย์ เรียกถี่เกินไปจาก IP เดียว หรือส่งเกิน 30 คำสั่งต่อนาทีต่อครีเอเตอร์ (นับรวม REST และ MCP) รอตามค่า Retry-After แล้วลองใหม่ |
503 | {"error":"auth_unavailable"} | ตรวจคีย์ไม่ได้ชั่วคราว ลองใหม่ตาม Retry-After (30 วินาที) |
503 | {"error":"timer_unavailable"} | นาฬิกาไม่เปลี่ยน ลองใหม่หลัง Retry-After (5 วินาที) |
Cache-Control no-store
curl -X POST "https://tipjai.com/api/v1/me/timer" \
-H "Authorization: Bearer tj_live_..." \
-H "Content-Type: application/json" \
-d '{"action":"add","seconds":300}'{
"action": "add",
"running": true,
"shows_seconds": 5400,
"timer_ends_at": "2026-10-27T15:30:00.123456+00:00",
"paused_seconds": 0,
"timer_mode": true
}ไม่มีปุ่มส่งคำขอจริงสำหรับ endpoint ที่ใช้คีย์ เพราะไม่ควรพิมพ์คีย์ลงหน้าเว็บ ใช้ตัวอย่างข้างบนในโค้ดฝั่งเซิร์ฟเวอร์ของคุณ