คู่มือ
ภาพรวม Data API
เรียก endpoint ของบุคคลที่สามผ่านคำนำหน้าร่วม ด้วยการยืนยันตัวตนและการจัดการคำขอที่สอดคล้องกัน
Data API คือแค็ตตาล็อกของ API บุคคลที่สามที่อยู่เบื้องหลังคีย์ Felo เดียว แยกจาก API /v2 ของ Felo เองและจาก Model API
คำนำหน้าร่วม
https://openapi.felo.ai/v1/betaเอกสารอ้างอิงแสดงแต่ละ endpoint เป็นพาธแบบเต็มที่ขึ้นต้นด้วย /v1/beta ให้ใช้พาธนั้นตามเดิมบนโฮสต์ ห้ามเติมคำนำหน้าร่วมซ้ำอีก ตัวอย่างเช่น endpoint ค้นหาของ Tavily คือ:
POST https://openapi.felo.ai/v1/beta/tavily/searchค้นหา endpoint
- เรียกดูไดเรกทอรี APIตามซัพพลายเออร์
- เปิดเอกสารอ้างอิง Data APIสำหรับรายการ endpoint พารามิเตอร์ และสคีมาการตอบกลับแบบเต็ม
- ใช้แท็กในเอกสารอ้างอิงเพื่อสลับระหว่างซัพพลายเออร์
ซัพพลายเออร์แต่ละรายคงรูปแบบคำขอของตนเองไว้ ชั้นร่วมมีหน้าที่ทำให้การรับรองความถูกต้องและการกำหนดเส้นทางเป็นมาตรฐาน ไม่ใช่เนื้อหาคำขอ ให้อ่านสคีมาของ endpoint ก่อนส่งคำขอ
การรับรองความถูกต้อง
ใช้ header อย่างใดอย่างหนึ่ง:
Authorization: Bearer $FELO_API_KEYหรือ:
X-API-Key: $FELO_API_KEYส่ง Content-Type: application/json สำหรับเนื้อหาคำขอแบบ JSON
ตัวอย่างคำขอ
curl https://openapi.felo.ai/v1/beta/tavily/search \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "What is Felo AI?",
"max_results": 3
}'รูปแบบการตอบกลับมาจากซัพพลายเออร์ ฟิลด์เช่นผลลัพธ์ เคอร์เซอร์การแบ่งหน้า และเมทาดาทาไม่ได้ถูกทำให้เป็นมาตรฐานข้ามผู้ให้บริการ
ข้อกำหนดทั่วไป
| หัวข้อ | สิ่งที่คาดได้ |
|---|---|
| เนื้อหาคำขอ | JSON เฉพาะซัพพลายเออร์ ให้ปฏิบัติตามสคีมาของ endpoint |
| การแบ่งหน้า | ชื่อฟิลด์และรูปแบบเคอร์เซอร์แตกต่างกันตาม endpoint |
| ข้อผิดพลาด | JSON ที่มี status, code, message และ request_id รายละเอียดของผู้ให้บริการอาจปรากฏใน message |
| ขีดจำกัดอัตรา | ขึ้นอยู่กับ endpoint และซัพพลายเออร์ ให้คาดว่าจะพบ 429 เมื่อโหลดสูง |
| การเรียกเก็บเงิน | ต่อการเรียก จากยอดเครดิตบริการเดียวกับ Model API |
การจัดการข้อผิดพลาด
ความล้มเหลวในการรับรองความถูกต้องจะส่งซองข้อผิดพลาดเดียวกับส่วนอื่นของแพลตฟอร์ม:
{
"status": 401,
"code": "UNAUTHORIZED",
"message": "Invalid API Key",
"request_id": "..."
}สำหรับความล้มเหลวระดับผู้ให้บริการ ให้อ่านสถานะ HTTP และ message บันทึก method, พาธแบบเต็ม, รูปแบบเนื้อหาคำขอ และ request_id ไว้ในล็อก ห้ามบันทึกคีย์ API แบบเต็ม
การลองใหม่
ลองใหม่เมื่อได้รับการตอบกลับ 429 และ 5xx พร้อมการหน่วงแบบทวีคูณ ห้ามลองใหม่กับ 400 หรือ 401 โดยไม่เปลี่ยนแปลงอะไร การดำเนินการบางอย่างของผู้ให้บริการไม่ปลอดภัยหากทำซ้ำ ให้ตรวจสอบ endpoint ก่อนลองใหม่กับการเขียน
เมื่อใดควรใช้ Felo API แทน
ใช้ Data API เมื่อคุณต้องการแหล่งข้อมูลบุคคลที่สามที่เฉพาะเจาะจง ใช้ Felo API เมื่อคุณต้องการเวิร์กโฟลว์ของ Felo เอง:
- คำตอบที่มีการค้นหารองรับพร้อมการอ้างอิง: Chat API
- การสร้างสไลด์: PPT Task API
- หน้าแลนดิ้ง: Landing Page Task API
- ฐานความรู้และการค้นคืน: LiveDoc API
- บทสนทนาของ Agent พร้อมสตรีมมิ่ง: SuperAgent API