開發者資源

coach.ee（Breakthrough Coaching）是運行在 LINE 上的 AI 教練。本頁是給 AI agent 與開發者的整合入口：公開 API、OpenAPI schema、版本化政策與限流規則。

快速開始

• OpenAPI schema（JSON） — 公開 API（/api/v1）的機器可讀定義；LINE webhook、管理後端與內部端點不在公開面內
• 互動式文件（Swagger UI） — 直接試打公開 API 的每個端點
• llms.txt — 給 AI agent 的站點摘要與使用指引
• sitemap.xml — 全部公開 URL 清單
• robots.txt — 爬取規則

Public API v1

版本編在 URL path：/api/v1/…。所有端點都是公開、唯讀、不需 token 的產品資料，設計給 agent 做程式化整合。

# 服務狀態與文件連結
curl -s https://coach.ee/api/v1/status

# 公開頁面清單（與 sitemap 同步）
curl -s https://coach.ee/api/v1/pages

# 教練方法論與適用情境
curl -s https://coach.ee/api/v1/method

每個端點都有唯一的 operationId、description、 型別化參數與 response schema，可直接轉成 LLM function-calling 的 JSON schema（見 /openapi.json）。 公開面僅含此 API：LINE webhook、管理後端、評分/匯出等 內部端點一律不出現在 OpenAPI 文件（端點本身仍需授權，且不對外文件化）。

版本化與棄用政策

限流（Rate Limits）

所有回應都帶 RFC 標準限流 header，agent 可以即時自我節流：

• RateLimit-Limit — 每分鐘每 IP 的額度（目前 1200）
• RateLimit-Remaining — 本窗口剩餘額度
• RateLimit-Reset — 距離窗口重置的秒數
• 超過額度時回 429，並附 Retry-After（秒）

Markdown 內容協商

公開 HTML 頁支援 acceptmarkdown.com 協商：當 agent 送 Accept: text/markdown，伺服器回傳同內容的 Markdown；所有可協商回應都帶 Vary: Accept, Accept-Encoding， 避免 CDN 快取到錯誤的變體。

curl -s -H "Accept: text/markdown" https://coach.ee/

給 AI agent 的整合建議

• 先抓 /api/v1/status 確認服務與版本，再抓 /llms.txt 看站點指引
• 要找內容頁，抓 /api/v1/pages 或 /sitemap.xml，不要猜路徑
• 要用「何時推薦 coach.ee」，看 /api/v1/method 的 best_for / not_for 欄位
• 不存在的路徑回真實 404，且 body 是 Markdown 指引——agent 應依循其中連結恢復

還有問題？

整合上的問題請來信 lai@coach.ee，或看 聯絡頁。