เอกสารอ้างอิง API

เอกสารอ้างอิง API ฉบับสมบูรณ์ของ Polylane สร้างจากข้อกำหนด OpenAPI ที่แพลตฟอร์มให้บริการ จึงตรงกับสิ่งที่ deploy อยู่เสมอ

การยืนยันตัวตน

ส่งคีย์ API ของ workspace ใน header x-api-key หรือ access token แบบ OAuth ใน Authorization: Bearer สร้างอย่างใดอย่างหนึ่งในคอนโซล ดู คีย์ API และไคลเอนต์ OAuth

curl https://api.polylane.com/v1/workspaces \
  -H "x-api-key: $POLYLANE_API_KEY"

รูปแบบการตอบกลับ

ทุกการตอบกลับแบบ JSON ใช้ envelope เดียวกัน

{
  "success": true,
  "message": { "message": "Successful request" },
  "error": null,
  "result": { "items": [], "count": 0 }
}

ขีดจำกัดอัตรา

การตอบกลับประกาศนโยบายใน header RateLimit-Limit และ RateLimit-Policy เมื่อเกินขีดจำกัด API จะตอบ 429 พร้อม header Retry-After ที่บอกหน้าต่างเวลาเป็นวินาที ให้รอจนกว่าจะพ้นช่วงนั้นแล้วลองใหม่

ทุก operation ยังเรียกได้จาก CLI ซึ่งสร้างจากข้อกำหนดเดียวกัน

ที่เกี่ยวข้อง

• คีย์ API และไคลเอนต์ OAuth เพื่อสร้างข้อมูลรับรองที่คำขอเหล่านี้ใช้
• CLI เพื่อเรียก API จากเทอร์มินัลหรือสคริปต์
• เซิร์ฟเวอร์ MCP ของแพลตฟอร์ม เพื่อเข้าถึงข้อมูลเดียวกันจากเอเจนต์ของตัวแก้ไข