API 參考文件
成員 API「成員 API」的直接連結
下列端點的根 URL 為：/v1/org/members
| 方法 | 端點 | 說明 |
|---|---|---|
| GET | / | 列出成員 |
| POST | /invitations | 傳送邀請 |
| GET | /invitations | 列出邀請 |
| DELETE | /invitations/:id | 撤銷邀請 |
| PATCH | /:id | 更新成員角色 |
| DELETE | /:id | 移除成員 |
API token「API token」的直接連結
下列端點的根 URL 為：/v1/auth/tokens
| 方法 | 端點 | 說明 |
|---|---|---|
| POST | / | 建立 API token |
| GET | / | 列出 API token |
| DELETE | /:id | 刪除 API token |
Studio API「Studio API」的直接連結
下列端點的根 URL 為：/v1/studio
| 方法 | 端點 | 說明 |
|---|---|---|
| GET | /projects | 列出 Studio 專案 |
| POST | /projects | 建立專案 |
| GET | /projects/:id | 取得專案詳細資料與部署項目 |
| DELETE | /projects/:id | 刪除專案 |
| POST | /deploys | 建立部署項目 |
| POST | /deploys/:id/upload-complete | 確認產物上傳完成 |
| GET | /deploys/:id | 取得部署狀態 |
| GET | /deploys/:id/logs | 取得部署記錄 |
| GET | /deploys/:id/logs/stream | 串流傳輸部署記錄（SSE） |
Server API「Server API」的直接連結
下列端點的根 URL 為：/v1/server
| 方法 | 端點 | 說明 |
|---|---|---|
| GET | /projects | 列出 server 專案 |
| POST | /projects | 建立專案 |
| GET | /projects/:id | 取得專案詳細資料 |
| DELETE | /projects/:id | 刪除專案 |
| PUT | /projects/:id/env | 設定環境變數 |
| GET | /projects/:id/env | 取得環境變數 |
| POST | /projects/:id/env/restart | 變更環境變數後重新啟動 |
| GET | /projects/:id/domains | 列出網域 |
| POST | /projects/:id/domains | 新增自訂網域 |
| GET | /projects/:id/runtime-logs | 取得執行階段記錄 |
| POST | /projects/:id/redeploy | 觸發重新部署 |
| POST | /projects/:id/always-on | 啟用 always-on |
| DELETE | /projects/:id/always-on | 停用 always-on |
| POST | /deploys | 建立部署項目 |
| POST | /deploys/:id/upload-complete | 確認產物上傳完成 |
| GET | /deploys/:id | 取得部署狀態 |
| GET | /deploys/:id/logs | 取得部署記錄 |
| POST | /deploys/:id/cancel | 取消佇列中或進行中的部署 |
| DELETE | /deploys/:id | 停止執行中的部署 |
Gateway API「Gateway API」的直接連結
下列端點的根 URL 為：/v1/gateway
| 方法 | 端點 | 說明 |
|---|---|---|
| GET | /projects | 列出 Gateway 專案 |
| GET | /projects/:id | 取得專案詳細資料 |
| PATCH | /projects/:id | 更新專案設定 |
| DELETE | /projects/:id | 刪除專案 |
| POST | /projects/provision | 佈建新的 Gateway 專案 |
| GET | /projects/:id/keys | 列出 API 金鑰 |
| POST | /projects/:id/keys | 建立 API 金鑰 |
| DELETE | /projects/:id/keys/:keyId | 撤銷 API 金鑰 |
| GET | /projects/:id/keys/:keyId/bindings | 列出金鑰層級的 Provider binding |
| POST | /projects/:id/keys/:keyId/bindings | 新增金鑰層級的 Provider binding（BYOK） |
| DELETE | /projects/:id/keys/:keyId/bindings/:provider | 移除金鑰層級的 binding |
| GET | /projects/:id/bindings | 列出專案層級的 Provider binding |
| POST | /projects/:id/bindings | 新增專案層級的 Provider binding（BYOK） |
| DELETE | /projects/:id/bindings/:provider | 移除專案層級的 binding |
| GET | /projects/:id/usage/has-activity | 檢查專案是否有任何要求 |
| GET | /projects/:id/usage/activity | 取得彙整後的用量活動 |
| GET | /projects/:id/usage/memory-activity | 取得一段時間範圍內的 memory-token 總量 |
| GET | /projects/:id/usage/logs | 取得要求記錄 |
| GET | /projects/:id/usage/logs/facets | 取得記錄篩選 facet |
| GET | /projects/:id/usage/logs/:requestId | 取得特定要求的詳細資料 |
| GET | /projects/:id/memory/threads | 列出 thread（dashboard） |
| POST | /projects/:id/memory/threads | 建立 thread（dashboard） |
| GET | /projects/:id/memory/threads/:threadId | 取得 thread（dashboard） |
| PATCH | /projects/:id/memory/threads/:threadId | 更新 thread（dashboard） |
| DELETE | /projects/:id/memory/threads/:threadId | 刪除 thread（dashboard） |
| POST | /projects/:id/memory/threads/:threadId/clone | 複製 thread（dashboard） |
| GET | /projects/:id/memory/threads/:threadId/messages | 列出訊息（dashboard） |
| POST | /projects/:id/memory/threads/:threadId/messages | 儲存訊息（dashboard） |
| DELETE | /projects/:id/memory/threads/:threadId/messages | 刪除訊息（dashboard） |
| GET | /projects/:id/memory/threads/:threadId/observations/history | 觀察記錄（dashboard） |
| GET | /models | 列出可用模型 |
Gateway proxy 端點「Gateway proxy 端點」的直接連結
詳情請參閱 Gateway 文件。