ภาพรวม
Postman
Postman คือเครื่องมือที่ช่วยพัฒนาและทดสอบ API ได้อย่างมีประสิทธิภาพ ช่วยให้คุณสร้าง จัดการ และทดสอบ API ได้ง่ายยิ่งขึ้น GPTBots มี Postman collections เพื่อให้การทดสอบ API สะดวกขึ้น
GPTBots Postman Collections
ข้อจำกัดพื้นฐาน
GPTBots API ออกแบบตามมาตรฐาน HTTP และ REST การร้องขอข้อมูลใช้เมธอด GET ส่วนการส่งข้อมูลใช้เมธอด POST หากใช้เมธอด HTTP ไม่ถูกต้องจะได้รับข้อความผิดพลาด
หากไม่ได้ระบุเป็นอย่างอื่น ค่าพารามิเตอร์ควรเข้ารหัสเป็น UTF-8 ด้วย URL encoding
การยืนยันตัวตน
GPTBots REST API ใช้ HTTP Basic Authentication ให้เพิ่ม Authorization header ดังนี้:
Authorization: Bearer ${API_Key}
การเปิดใช้งาน API
- เพื่อเปิดใช้งาน API ให้ไปที่แดชบอร์ด GPTBots เลือก "Agent Integration" แล้วเลือก "Development-API Service" จากนั้นคลิกปุ่ม "Enable" เพื่อเปิดใช้งาน
- หลังจากเปิดใช้งาน API แล้ว ให้คลิกที่การ์ด "API" เพื่อเข้าสู่หน้าจัดการ API จากนั้นคลิกปุ่ม "Create APIKey" เพื่อสร้าง APIKey สำหรับเรียกใช้งาน GPTBots APIs
API Base URLs
รูปแบบ URL ของ API:
https://api-${endpoint}.gptbots.ai/
{endpoint} คือศูนย์ข้อมูล (Data Center) ที่เลือกขณะสร้างองค์กร นักพัฒนาควรเลือก {endpoint} ให้เหมาะสมกับความต้องการ
รายชื่อ Data Center
ศูนย์ข้อมูลที่รองรับบน GPTBots มีดังนี้:
| Data Center | Endpoint | API Base URL |
|---|---|---|
| สิงคโปร์ | sg | https://api-sg.gptbots.ai/ |
| ญี่ปุ่น | jp | https://api-jp.gptbots.ai/ |
| ไทย | th | https://api-th.gptbots.ai/ |
หากไม่ได้ระบุ
-{endpoint}ใน URL จะใช้ศูนย์ข้อมูลสิงคโปร์เป็นค่าเริ่มต้น
ทุกการเรียก API ต้องระบุ endpoint ให้ถูกต้อง เช่น หากองค์กรใช้ศูนย์ข้อมูลสิงคโปร์ URL ที่ใช้จะเป็น:https://api-sg.gptbots.ai/v2/conversation
หมวดหมู่ API
แพลตฟอร์ม GPTBots ให้บริการ API ครอบคลุมความต้องการธุรกิจ นักพัฒนาสามารถเลือกใช้ API ตามหมวดหมู่ ดังนี้:
| หมวดหมู่ API | คำอธิบาย |
|---|---|
| Conversation API | สื่อสารและโต้ตอบกับ Agent ผ่าน API นี้ |
| Workflow API | ส่งคำร้องขอและรับผลลัพธ์จาก Workflow ผ่าน API นี้ |
| Knowledge API | จัดการคลังความรู้บน GPTBots ผ่าน API นี้ |
| Database API | จัดการฐานข้อมูลบน GPTBots ผ่าน API นี้ |
| Models API | เข้าถึงความสามารถของโมเดลต่าง ๆ บน GPTBots ผ่าน API นี้ |
| User API | กำหนดข้อมูลผู้ใช้ คุณสมบัติ และรายละเอียดการติดต่อผ่าน API นี้ |
| Analytics API | ตรวจสอบข้อมูลการใช้งาน credits และ tokens ผ่าน API นี้ |
| Account API | ดึงข้อมูล Agent องค์กร ฯลฯ ภายใต้บัญชีผ่าน API นี้ |
ข้อจำกัดการเรียก API
GPTBots จำกัดจำนวนครั้งในการเรียก API โดยแต่ละหมวดหมู่จะมีข้อจำกัดต่างกัน หากเกินจำนวนที่กำหนดจะได้รับแจ้งเตือนว่าเกินขีดจำกัด รายละเอียดดังนี้:
- แพ็กเกจฟรี: ทุก API จำกัด 3 ครั้งต่อนาที
- แพ็กเกจองค์กรแบบกำหนดเอง: กรุณาติดต่อทีมงาน GPTBots เพื่อขอสิทธิ์การใช้งาน API ตามความต้องการ