> For the complete documentation index, see [llms.txt](https://docs.maiagent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maiagent.ai/api/preparation/readme.md).

# 總覽說明

本文件列出 MaiAgent 平台可供串接的 API 端點：每支端點都有請求與回應欄位說明，以及 Shell、JavaScript、Python、PHP 四種語言的範例。第一次串接請先走完下方四步，再到[端點清單](#api-reference)找您要呼叫的端點。

## 開始使用 <a href="#getting-started" id="getting-started"></a>

### 1. 取得 API 金鑰 <a href="#step-api-key" id="step-api-key"></a>

組織內的成員可以在後台右上角頭像 → <mark style="color:blue;">帳號</mark> → <mark style="color:blue;">API 金鑰</mark> 為自己建立金鑰；具備「API Key 管理權限」的管理者也可以在 <mark style="color:blue;">組織設定</mark> → <mark style="color:blue;">API Key 管理</mark> 替指定成員簽發。完整金鑰只在建立當下顯示一次。兩種金鑰的取得方式與權限範圍見 [API 認證方式](/api/preparation/authentication.md)。

### 2. 基本網址與認證標頭 <a href="#step-base-url" id="step-base-url"></a>

SaaS 的 API 網址是 `https://api.maiagent.ai/api/v1/`，地端與私有雲部署請換成貴公司的平台網域；端點路徑以 `/` 結尾。每個請求都要在 `Authorization` 標頭帶入金鑰，前綴是 `Api-Key`（不是 `Bearer`）：

```
Authorization: Api-Key <您的 API 金鑰>
```

網址規則見 [網址與版本前綴](/api/preparation/conventions.md#base-url)，金鑰綁定成員與權限的規則見 [共通規範：認證](/api/preparation/conventions.md#authentication)。

### 3. 第一次呼叫 <a href="#step-first-call" id="step-first-call"></a>

以[列出 Agent](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-list)（`GET /api/v1/chatbots/`）為例：

```bash
curl https://api.maiagent.ai/api/v1/chatbots/ \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

回應是分頁格式（`count`、`next`、`previous`、`results`），欄位一律是 camelCase，見 [分頁](/api/preparation/conventions.md#pagination) 與 [欄位格式](/api/preparation/conventions.md#field-format)。收到 `401` 時請確認金鑰狀態與標頭格式，各狀態碼的含意見 [狀態碼](/api/preparation/status-code.md)。

### 4. 下一步 <a href="#step-next" id="step-next"></a>

* 速率限制、錯誤回應格式、上傳大小上限等跨端點規則：[API 共通規範](/api/preparation/conventions.md)
* 回應的狀態碼與錯誤範例：[狀態碼](/api/preparation/status-code.md)
* 轉真人後接收事件：[轉真人 Webhook 事件](/api/preparation/handoff-webhook.md)
* 從建立對話到接回覆的完整流程：技術人員手冊 [快速上手](https://docs.maiagent.ai/tech/api-integration/quickstart)
* 各端點的欄位與範例：下方[端點清單](#api-reference)，或左側「API 端點說明文件」各分類頁

## 串接範例程式碼 <a href="#examples" id="examples"></a>

若需參考 API 完整用例及程式碼，可至以下 Github Repository 查看：

* C# 範例
* Python 範例

{% embed url="<https://github.com/Playma-Co-Ltd/maiagent-api-examples>" %}

## API 分類與端點列表 <a href="#api-reference" id="api-reference"></a>

每支端點的請求與回應欄位、各語言範例在分類頁；回應狀態碼的含意以 [狀態碼](/api/preparation/status-code.md) 為準。

### AI 助理

* `POST` [api/v1/chatbots](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-create): 建立新 AI 助理
* `GET` [api/v1/embedding-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#embedding-models-list): 列出 Embedding Model
* `GET` [api/v1/reranker-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#reranker-models-list): 列出 Reranker Model
* `GET` [api/v1/large-language-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#large-language-models-list): 列出大型語言模型
* `GET` [api/v1/chatbots](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-list): 取得 AI 助理列表
* `GET` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-retrieve): 取得特定 AI 助理
* `PUT` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-update): 更新 AI 助理
* `PATCH` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-partial-update): 部分更新 AI 助理
* `DELETE` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-destroy): 刪除 AI 助理
* `POST` [api/v1/chatbots/{id}/duplicate](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-duplicate-create): 複製 AI 助理
* `PATCH` [api/v1/chatbots/{id}/enable-evaluation](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-enable-evaluation-partial-update): 啟用或停用評估功能
* `GET` [api/v1/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-list): 列出組織的 Hook
* `POST` [api/v1/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-create): 依樣板建立 Hook
* `GET` [api/v1/hooks/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-retrieve): 取得特定 Hook
* `PATCH` [api/v1/hooks/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-partial-update): 部分更新 Hook
* `DELETE` [api/v1/hooks/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#hooks-destroy): 刪除 Hook
* `GET` [api/v1/chatbots/{chatbotId}/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-hooks-retrieve): 列出 AI 助理掛載的 Hook
* `PUT` [api/v1/chatbots/{chatbotId}/hooks](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#chatbots-hooks-update): 整批替換 AI 助理掛載的 Hook
* `GET` [api/v1/schedules](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-list): 列出排程
* `POST` [api/v1/schedules](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-create): 建立排程
* `GET` [api/v1/schedules/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-retrieve): 取得特定排程
* `PATCH` [api/v1/schedules/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-partial-update): 部分更新排程
* `DELETE` [api/v1/schedules/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-destroy): 刪除排程
* `POST` [api/v1/schedules/{id}/run-now](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-run-now-create): 立即執行排程
* `POST` [api/v1/schedules/{id}/toggle](https://docs.maiagent.ai/api/api-reference/ai-zhu-li#schedules-toggle-create): 啟用或停用排程

### 附件與檔案

* `POST` [api/v1/attachments-upload](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#attachments-upload-create): 建立新附件 (整合)
* `POST` [api/v1/upload-presigned-url](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#upload-presigned-url-create): 取得檔案上傳用的預簽署 URL
* `POST` [api/v1/attachments](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#attachments-create): Presigned 上傳附件
* `GET` [api/v1/attachments/{id}](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#attachments-retrieve): 取得特定附件
* `POST` [api/v1/conversations/{conversationPk}/attachments](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#conversations-attachments-create): 建立對話附件
* `GET` [api/v1/allowed-file-specs](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#allowed-file-specs-retrieve): 取得允許的檔案規格
* `GET` [api/v1/file-library/conversation-attachments](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#file-library-conversation-attachments-list): 列出對話附件
* `DELETE` [api/v1/file-library/conversation-attachments/{id}](https://docs.maiagent.ai/api/api-reference/fu-jian-he-dang-an#file-library-conversation-attachments-destroy): 刪除對話附件

### 知識庫（新版）

* `POST` [api/v1/knowledge-bases](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-create): 建立知識庫
* `GET` [api/v1/knowledge-bases](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-list): 列出所有知識庫
* `GET` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-retrieve): 取得特定知識庫詳情
* `POST` [api/v1/knowledge-bases/{id}/search](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-search-create): 搜尋特定知識庫的內容
* `PUT` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-update): 更新知識庫
* `PATCH` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-partial-update): 部分更新知識庫
* `DELETE` [api/v1/knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-destroy): 刪除知識庫
* `GET` [api/v1/knowledge-bases/{id}/check-rrf-availability](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-check-rrf-availability-retrieve): 檢查 RRF 可用性
* `GET` [api/v1/knowledge-bases/{id}/export-labels-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-export-labels-excel-retrieve): 匯出標籤 Excel
* `POST` [api/v1/knowledge-bases/{id}/import-labels-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-import-labels-excel-create): 匯入標籤 Excel
* `GET` [api/v1/knowledge-bases/{id}/export-metadata-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-export-metadata-excel-retrieve): 匯出元資料 Excel
* `POST` [api/v1/knowledge-bases/{id}/import-metadata-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-import-metadata-excel-create): 匯入元資料 Excel
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/labels](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-create): 建立新標籤
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/labels](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-list): 列出知識庫中的標籤
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-retrieve): 取得特定標籤詳情
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-update): 更新標籤
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-partial-update): 部分更新標籤
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-labels-destroy): 刪除標籤
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-create): 建立元資料欄位
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-list): 列出元資料欄位
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-retrieve): 取得特定元資料欄位
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-metadata-keys-update): 更新元資料欄位
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/files](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-create): 上傳檔案到知識庫
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/update-metadata](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-update-metadata-partial-update): 更新檔案元資料
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-delete](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-batch-delete-create): 批量刪除檔案
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-reparse](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-batch-reparse-partial-update): 批量重新解析檔案
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-list): 列出知識庫中的檔案
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-retrieve): 取得特定檔案詳情
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/latest-failed-reason](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-latest-failed-reason-retrieve): 取得檔案最新失敗原因
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/transcription](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-transcription-retrieve): 取得檔案轉錄內容
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-update): 更新檔案資訊
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-partial-update): 部分更新檔案
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-destroy): 刪除檔案
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-create): 建立檔案翻譯
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-list): 列出檔案翻譯
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-retrieve): 取得特定翻譯
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-destroy): 刪除翻譯
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/download](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-files-translations-download-retrieve): 下載翻譯檔案
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/documents](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-list): 列出知識庫文件
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-update): 更新文件
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-partial-update): 部分更新文件
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-documents-destroy): 刪除文件
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-create): 建立新的 FAQ
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/update-metadata](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-update-metadata-partial-update): 更新 FAQ 元資料
* `POST` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-batch-delete-create): 批量刪除 FAQ
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-list): 列出特定知識庫的所有 FAQ
* `GET` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-retrieve): 取得特定 FAQ 詳情
* `PUT` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-update): 更新 FAQ
* `PATCH` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-partial-update): 部分更新 FAQ
* `DELETE` [api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faqs-destroy): 刪除 FAQ
* `GET` [api/v1/knowledge-bases/{id}/export-faq-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-export-faq-excel-retrieve): 匯出 FAQ Excel（或空白範本）
* `POST` [api/v1/knowledge-bases/{id}/import-faq-excel](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-import-faq-excel-create): 匯入 FAQ Excel（非同步）
* `GET` [api/v1/knowledge-bases/{id}/faq-import-jobs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faq-import-jobs-list): 列出 FAQ 匯入工作
* `GET` [api/v1/knowledge-bases/{id}/faq-import-jobs/{jobId}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#knowledge-bases-faq-import-jobs-retrieve): 取得特定 FAQ 匯入工作
* `GET` [api/v1/parsers](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#parsers-list): 列出解析器
* `GET` [api/v1/parsers/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-xin-ban#parsers-retrieve): 取得特定解析器

### 知識庫（舊版）

* `GET` [api/v1/chatbots/{id}/knowledge-bases-files](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbots-knowledge-bases-files-list): 取得 AI 助理的知識庫檔案列表
* `GET` [api/v1/chatbots/{id}/knowledge-bases-faqs](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbots-knowledge-bases-faqs-list): 取得 AI 助理的知識庫 FAQ 列表
* `GET` [api/v1/chatbot-text-nodes](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbot-text-nodes-list): 取得 AI 助理的所有檔案的文本節點
* `GET` [api/v1/chatbot-text-nodes/{id}](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbot-text-nodes-retrieve): 取得 AI 助理的特定檔案的文本節點
* `POST` [api/v1/chatbots/{id}/search](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#chatbots-search-create): 搜尋測試
* `GET` [api/v1/parsers/supported-file-types](https://docs.maiagent.ai/api/api-reference/zhi-shi-ku-jiu-ban#parsers-supported-file-types-list): 列出檔案類型支援的解析器

### 對話與訊息

* `POST` [api/v1/chatbots/{chatbotId}/completions](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#chatbots-completions-create): 發送訊息 (串流)
* `POST` [api/v1/messages](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-create): 發送訊息 (建立)
* `POST` [api/v1/messages/outgoing](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-outgoing-create): 發送主動訊息
* `POST` [api/v1/conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-create): 建立新的對話
* `GET` [api/v1/messages](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-list): 取得訊息列表
* `GET` [api/v1/messages/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-retrieve): 取得特定訊息
* `GET` [api/v1/conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-list): 取得對話列表
* `GET` [api/v1/conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-retrieve): 取得特定對話
* `PATCH` [api/v1/conversations/{id}/rename](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-rename-partial-update): 重新命名對話
* `DELETE` [api/v1/conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-destroy): 刪除對話
* `POST` [api/v1/conversations/{id}/stop-response](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-stop-response-create): 中止 AI 回覆
* `POST` [api/v1/conversations/{id}/satisfaction](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-satisfaction-create): 提交對話滿意度
* `GET` [api/v1/conversations/{id}/events](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-events-retrieve): 列出對話事件
* `PATCH` [api/v1/conversations/{id}/assign](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-assign-partial-update): 指派對話給成員
* `PATCH` [api/v1/conversations/{id}/claim](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-claim-partial-update): 認領對話
* `PATCH` [api/v1/conversations/{id}/transfer](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-transfer-partial-update): 轉接對話給其他成員
* `PATCH` [api/v1/conversations/{id}/return-to-ai](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-return-to-ai-partial-update): 轉回 AI 回覆
* `GET` [api/v1/conversations/{conversationId}/outputs](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-outputs-retrieve): 列出對話產出檔案
* `POST` [api/v1/conversations/{conversationPk}/share](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-share-create): 分享對話
* `POST` [api/v1/conversations/{conversationPk}/share/quick](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#conversations-share-quick-create): 快速分享對話
* `GET` [api/v1/shared-conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-list): 列出分享的對話
* `GET` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-retrieve): 取得特定分享對話
* `PATCH` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-partial-update): 更新分享對話
* `DELETE` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-destroy): 刪除分享對話
* `POST` [api/v1/shared-conversations/{id}/fork](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-fork-create): 複製分享對話
* `GET` [api/v1/shared-conversations/my-shares](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#shared-conversations-my-shares-retrieve): 取得我的分享列表
* `POST` [api/v1/messages/{messagePk}/feedback](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-feedback-create): 建立訊息回饋
* `PUT` [api/v1/messages/{messagePk}/feedback/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-feedback-update): 更新訊息回饋
* `DELETE` [api/v1/messages/{messagePk}/feedback/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#messages-feedback-destroy): 刪除訊息回饋
* `GET` [api/v1/records](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-list): 取得對話紀錄列表
* `GET` [api/v1/records/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-retrieve): 取得特定對話紀錄
* `POST` [api/v1/records/export-excel-requests](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-export-excel-requests-create): 建立對話紀錄匯出請求
* `GET` [api/v1/records/export-excel-requests/{exportId}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi#records-export-excel-requests-retrieve2): 取得對話紀錄匯出狀態

### 對話 Widget

* `POST` [api/v1/web-chats](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-create): 建立 Web Chat
* `GET` [api/v1/web-chats](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-list): 列出 Web Chat
* `GET` [api/v1/web-chats/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-retrieve): 取得特定 Web Chat
* `PUT` [api/v1/web-chats/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-update): 更新 Web Chat
* `PATCH` [api/v1/web-chats/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-partial-update): 部分更新 Web Chat
* `POST` [api/v1/web-chats/{id}/setup-contact-credentials](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-setup-contact-credentials-create): 設定聯絡人憑證
* `POST` [api/v1/web-chats/{id}/voice-agent/token](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-voice-agent-token-create): 取得語音助理 Token
* `POST` [api/v1/web-chats/{webchatPk}/batch-qas](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-batch-qas-create): 上傳批次 QA 檔案
* `GET` [api/v1/web-chats/{webchatPk}/batch-qas/{id}/export-excel](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#web-chats-batch-qas-export-excel-retrieve): 匯出批次 QA 為 Excel
* `GET` [api/v1/chatbots/{chatbotPk}/llm-usage-statistics](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#chatbots-llm-usage-statistics-list): 取得 LLM 使用統計
* `GET` [api/v1/chatbots/{chatbotPk}/statistics](https://docs.maiagent.ai/api/api-reference/dui-hua-widget#chatbots-statistics-list): 取得 AI 助理統計數據

### 對話平台

* `GET` [api/v1/inboxes](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-list): 列出對話平台
* `POST` [api/v1/inboxes](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-create): 建立對話平台
* `GET` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-retrieve): 取得特定對話平台
* `PUT` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-update): 更新對話平台
* `PATCH` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-partial-update): 部分更新對話平台
* `DELETE` [api/v1/inboxes/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-destroy): 刪除對話平台
* `GET` [api/v1/inboxes/{inboxPk}/webhooks](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-list): 列出對話平台的 Webhook
* `POST` [api/v1/inboxes/{inboxPk}/webhooks](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-create): 建立 Webhook
* `GET` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-retrieve): 取得特定 Webhook
* `PUT` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-update): 更新 Webhook
* `PATCH` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-partial-update): 部分更新 Webhook
* `DELETE` [api/v1/inboxes/{inboxPk}/webhooks/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-ping-tai#inboxes-webhooks-destroy): 刪除 Webhook

### 組織與成員

* `POST` [api/v1/auth/registration](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#auth-registration-create): 帳號註冊
* `POST` [api/v1/auth/password/change](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#auth-password-change-create): 更換密碼
* `POST` [api/v1/organizations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-create): 建立新組織
* `POST` [api/v1/organizations/{organizationPk}/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-create): 新增成員至指定組織
* `POST` [api/v1/organizations/{organizationPk}/members/bulk-import](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-bulk-import-create): 批次匯入成員
* `GET` [api/v1/organizations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-list): 取得組織列表
* `GET` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-retrieve): 取得特定組織資訊
* `GET` [api/v1/users/current](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#users-current-retrieve): 取得當前用戶詳細資訊
* `GET` [api/v1/permissions](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#permissions-list): 取得當前用戶權限
* `GET` [api/v1/organizations/{organizationPk}/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-list): 取得指定組織的成員列表
* `GET` [api/v1/organizations/{organizationPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-retrieve): 取得特定成員詳細資訊
* `PUT` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-update): 更新組織資訊
* `PUT` [api/v1/users/current](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#users-current-update): 更新當前用戶詳細資訊
* `POST` [api/v1/organizations/{organizationPk}/members/{id}/update-groups](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-update-groups-create): 更新成員所屬角色
* `PATCH` [api/v1/organizations/{organizationPk}/members/{id}/display-name](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-display-name-partial-update): 修改成員名稱
* `POST` [api/v1/auth/unified-invitations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#auth-unified-invitations-create): 邀請成員加入組織
* `GET` [api/v1/auth/organization-mail-invitations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#auth-organization-mail-invitations-list): 列出組織邀請信紀錄
* `POST` [api/v1/auth/organization-mail-invitations/{id}/resend](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#auth-organization-mail-invitations-resend-create): 重寄組織邀請信
* `GET` [api/v1/organizations/{organizationPk}/api-keys](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-list): 列出組織的 API Key
* `POST` [api/v1/organizations/{organizationPk}/api-keys](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-create): 替成員簽發 API Key
* `GET` [api/v1/organizations/{organizationPk}/api-keys/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-retrieve): 取得特定 API Key
* `PATCH` [api/v1/organizations/{organizationPk}/api-keys/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-partial-update): 更新 API Key 設定
* `DELETE` [api/v1/organizations/{organizationPk}/api-keys/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-api-keys-destroy): 撤銷 API Key
* `GET` [api/v1/users/api-key-context](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#users-api-key-context-retrieve): 查詢 API Key 所屬組織
* `POST` [api/v1/members/embed-tokens](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#members-embed-tokens-create): 換發成員嵌入 token
* `GET` [api/v1/oauth/applications](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-list): 列出 OAuth 應用程式
* `POST` [api/v1/oauth/applications](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-create): 註冊 OAuth 應用程式
* `GET` [api/v1/oauth/applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-retrieve): 取得特定 OAuth 應用程式
* `PATCH` [api/v1/oauth/applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-partial-update): 更新 OAuth 應用程式
* `DELETE` [api/v1/oauth/applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-destroy): 刪除 OAuth 應用程式並撤銷其 token
* `POST` [api/v1/oauth/applications/{id}/regenerate-secret](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-applications-regenerate-secret-create): 重新產生 client secret
* `GET` [api/v1/oauth/authorized-applications](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-authorized-applications-list): 列出我授權過的 OAuth 應用程式
* `DELETE` [api/v1/oauth/authorized-applications/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#oauth-authorized-applications-destroy): 撤銷我對某應用程式的授權
* `DELETE` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-destroy): 刪除組織
* `DELETE` [api/v1/organizations/{organizationPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-members-destroy): 刪除指定成員
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-members-list): 取得成員使用統計
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/members/summary](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-members-summary-retrieve): 取得成員使用統計摘要
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/chatbots](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-chatbots-list): 取得 AI 助理使用統計
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/chatbots/summary](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#organizations-usage-statistics-chatbots-summary-retrieve): 取得 AI 助理使用統計摘要
* `GET` [api/v1/me/memories](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-list): 列出自己的記憶
* `POST` [api/v1/me/memories](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-create): 建立或更新自己的記憶
* `PATCH` [api/v1/me/memories/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-partial-update): 修改或重新啟用自己的記憶
* `DELETE` [api/v1/me/memories/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan#me-memories-destroy): 刪除自己的記憶

### 角色與權限

* `POST` [api/v1/organizations/{organizationPk}/groups](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-create): 建立角色
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-bulk-create-create): 批量新增角色成員
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-chatbots-bulk-create-create): 批量分配 AI 助理給角色
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-inboxes-bulk-create-create): 批量分配收件匣給角色
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-knowledge-bases-bulk-create-create): 批量分配知識庫給角色
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases/bulk-create](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-databases-bulk-create-create): 批量分配資料庫給角色
* `GET` [api/v1/permissions](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#permissions-list): 列出權限清單
* `GET` [api/v1/organizations/{organizationPk}/groups](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-list): 取得角色列表
* `GET` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-retrieve): 取得角色的詳情
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-list): 取得角色成員列表
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-retrieve): 查看特定角色成員
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-chatbots-list): 取得角色的 AI 助理列表
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-inboxes-list): 取得角色的收件匣列表
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-knowledge-bases-list): 取得角色的知識庫列表
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-databases-list): 取得角色的資料庫列表
* `PUT` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-update): 更新角色權限
* `PATCH` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-partial-update): 部分更新角色權限
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-destroy): 刪除角色
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-members-destroy): 移除角色成員
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-chatbots-destroy): 移除角色裡的 AI 助理
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-inboxes-destroy): 移除角色裡的收件匣
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-knowledge-bases-destroy): 移除角色裡的知識庫
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases/{id}](https://docs.maiagent.ai/api/api-reference/jue-se-he-quan-xian#organizations-groups-group-databases-destroy): 移除角色裡的資料庫

### 聯絡人

* `GET` [api/v1/contacts](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-list): 列出聯絡人
* `POST` [api/v1/contacts](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-create): 建立聯絡人
* `GET` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-retrieve): 取得聯絡人詳情
* `PUT` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-update): 更新聯絡人
* `PATCH` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-partial-update): 部分更新聯絡人
* `DELETE` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-destroy): 刪除聯絡人
* `GET` [api/v1/contacts/{id}/conversations](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-conversations-list): 取得聯絡人的對話列表
* `GET` [api/v1/contacts/{id}/conversations/latest](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-conversations-latest-retrieve): 取得聯絡人最新對話
* `POST` [api/v1/contacts/broadcast-message](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-broadcast-message-create): 群發訊息
* `POST` [api/v1/contacts/{id}/api-credentials](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-api-credentials-create): 為聯絡人建立 API 憑證
* `PATCH` [api/v1/contacts/{id}/api-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-api-credentials-partial-update): 更新聯絡人的 API 憑證
* `DELETE` [api/v1/contacts/{id}/api-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-api-credentials-destroy): 刪除聯絡人的 API 憑證
* `POST` [api/v1/contacts/{id}/mcp-credentials](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-mcp-credentials-create): 為聯絡人建立 MCP 憑證
* `PATCH` [api/v1/contacts/{id}/mcp-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-mcp-credentials-partial-update): 更新聯絡人的 MCP 憑證
* `DELETE` [api/v1/contacts/{id}/mcp-credentials/{credentialId}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-mcp-credentials-destroy): 刪除聯絡人的 MCP 憑證
* `GET` [api/v1/contacts/bulk-import-template](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-bulk-import-template-retrieve): 下載聯絡人批次匯入範本
* `POST` [api/v1/contacts/bulk-import](https://docs.maiagent.ai/api/api-reference/lian-luo-ren#contacts-bulk-import-create): 批次匯入聯絡人

### 工具與連接器

* `POST` [api/v1/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-create): 建立工具
* `GET` [api/v1/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-list): 列出工具
* `GET` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-retrieve): 取得特定工具
* `PUT` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-update): 更新工具
* `PATCH` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-partial-update): 部分更新工具
* `DELETE` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-destroy): 刪除工具
* `POST` [api/v1/tools/available-tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-available-tools-create): 列出可用工具
* `POST` [api/v1/connectors](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-create): 建立連接器
* `GET` [api/v1/connectors](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-list): 列出連接器
* `GET` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-retrieve): 取得特定連接器
* `PUT` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-update): 更新連接器
* `PATCH` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-partial-update): 部分更新連接器
* `DELETE` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-destroy): 刪除連接器
* `GET` [api/v1/connectors/{id}/authorized-members](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-authorized-members-retrieve): 列出連接器授權成員
* `DELETE` [api/v1/connectors/{id}/authorized-members/{memberId}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#connectors-authorized-members-destroy): 移除連接器授權成員
* `GET` [api/v1/mcp/registry](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-registry-list): 列出 MCP 工具登錄
* `GET` [api/v1/mcp/registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-registry-retrieve): 取得特定 MCP 工具登錄
* `GET` [api/v1/mcp/private-registry](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-list): 列出組織自架的 MCP Server
* `POST` [api/v1/mcp/private-registry](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-create): 新增自架 MCP Server
* `GET` [api/v1/mcp/private-registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-retrieve): 取得特定自架 MCP Server
* `PATCH` [api/v1/mcp/private-registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-partial-update): 部分更新自架 MCP Server
* `DELETE` [api/v1/mcp/private-registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-destroy): 刪除自架 MCP Server
* `POST` [api/v1/mcp/private-registry/test-connection](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#mcp-private-registry-test-connection-create): 測試 MCP Server 連線
* `GET` [api/v1/tool-execution-records](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-list): 取得工具執行紀錄列表
* `GET` [api/v1/tool-execution-records/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-retrieve): 取得特定工具執行紀錄
* `GET` [api/v1/tool-execution-records/chatbots](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-chatbots-list): 取得執行紀錄的 AI 助理過濾選項
* `GET` [api/v1/tool-execution-records/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tool-execution-records-tools-list): 取得執行紀錄的工具過濾選項
* `GET` [api/v1/tools/{toolPk}/tool-execution-records](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-list): 取得特定工具的執行紀錄列表
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-retrieve): 取得特定工具的特定執行紀錄
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/chatbots](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-chatbots-list): 取得特定工具執行紀錄的 AI 助理過濾選項
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi#tools-tool-execution-records-tools-list): 取得特定工具執行紀錄的工具過濾選項

### 技能

* `POST` [api/v1/skills/upload](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-upload-create): 上傳技能
* `POST` [api/v1/skills](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-create): 建立技能
* `GET` [api/v1/skills](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-list): 列出技能
* `GET` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-retrieve): 取得特定技能
* `PUT` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-update): 更新技能
* `PATCH` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-partial-update): 部分更新技能
* `DELETE` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-destroy): 刪除技能
* `GET` [api/v1/skills/{id}/export](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-export-retrieve): 匯出技能
* `GET` [api/v1/skills/{id}/package-structure](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-package-structure-retrieve): 瀏覽技能包目錄結構
* `POST` [api/v1/skills/{id}/reupload](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-reupload-create): 重新上傳技能
* `GET` [api/v1/skills/{skillPk}/resources](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-list): 列出技能資源
* `POST` [api/v1/skills/{skillPk}/resources](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-create): 上傳技能資源
* `DELETE` [api/v1/skills/{skillPk}/resources/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-destroy): 刪除技能資源
* `GET` [api/v1/skills/{skillPk}/resources/{id}/download](https://docs.maiagent.ai/api/api-reference/ji-neng#skills-resources-download-retrieve): 下載技能資源

### 資料庫

* `POST` [api/v1/sql-databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-create): 建立 SQL 資料庫連線
* `GET` [api/v1/sql-databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-list): 列出 SQL 資料庫
* `GET` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-retrieve): 取得特定 SQL 資料庫
* `PUT` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-update): 更新 SQL 資料庫
* `PATCH` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-partial-update): 部分更新 SQL 資料庫
* `DELETE` [api/v1/sql-databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-destroy): 刪除 SQL 資料庫
* `POST` [api/v1/sql-databases/{id}/test-connection](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-test-connection-create): 測試資料庫連線
* `POST` [api/v1/sql-databases/{id}/upload-files](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-upload-files-create): 上傳檔案至資料庫
* `POST` [api/v1/sql-databases/batch-delete](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-batch-delete-create): 批量刪除 SQL 資料庫
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-list): 列出資料表
* `POST` [api/v1/sql-databases/{sqlDatabasePk}/tables](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-create): 建立資料表
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-retrieve): 取得特定資料表
* `PUT` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-update): 更新資料表
* `PATCH` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-partial-update): 部分更新資料表
* `DELETE` [api/v1/sql-databases/{sqlDatabasePk}/tables/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-destroy): 刪除資料表
* `POST` [api/v1/sql-databases/{sqlDatabasePk}/tables/batch-delete](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-batch-delete-create): 批量刪除資料表
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-list): 列出資料欄位
* `GET` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-retrieve): 取得特定資料欄位
* `PUT` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-update): 更新資料欄位
* `PATCH` [api/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#sql-databases-tables-columns-partial-update): 部分更新資料欄位
* `POST` [api/v1/database-connection/test](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#database-connection-test-create): 測試資料庫連線（通用）
* `GET` [api/v1/database-examples](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#database-examples-list): 列出資料庫連線字串範例
* `GET` [api/v1/database-examples/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#database-examples-retrieve): 取得特定連線字串範例
* `GET` [api/v1/chatbots/{chatbotPk}/databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-list): 列出 AI 助理的資料庫配置
* `POST` [api/v1/chatbots/{chatbotPk}/databases](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-create): 新增 AI 助理的資料庫配置
* `GET` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-retrieve): 取得特定資料庫配置
* `PUT` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-update): 更新資料庫配置
* `PATCH` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-partial-update): 部分更新資料庫配置
* `DELETE` [api/v1/chatbots/{chatbotPk}/databases/{id}](https://docs.maiagent.ai/api/api-reference/zi-liao-ku#chatbots-databases-destroy): 刪除資料庫配置

### 評估與測試集

* `GET` [api/v1/dataset](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-list): 列出測試集
* `POST` [api/v1/dataset](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-create): 建立空白測試集
* `POST` [api/v1/dataset/upload](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-upload-create): 上傳 CSV 或 Excel 建立測試集
* `POST` [api/v1/dataset/generate-from-file](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-generate-from-file-create): 從知識庫檔案生成測試集
* `GET` [api/v1/dataset/knowledge-base-files](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-knowledge-base-files-retrieve): 列出可生成測試案例的知識庫檔案
* `GET` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-retrieve): 取得特定測試集
* `GET` [api/v1/dataset/{id}/details](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-details-retrieve): 取得測試集與單輪測試案例
* `PUT` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-update): 更新測試集
* `PATCH` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-partial-update): 部分更新測試集
* `DELETE` [api/v1/dataset/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#dataset-destroy): 刪除測試集
* `GET` [api/v1/test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-list): 列出單輪測試案例
* `POST` [api/v1/test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-create): 建立單輪測試案例
* `POST` [api/v1/test-case/upload](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-upload-create): 上傳 CSV 或 Excel 加入測試案例
* `POST` [api/v1/test-case/generate-from-file](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-generate-from-file-create): 從知識庫檔案生成單輪測試案例
* `GET` [api/v1/test-case/generation-jobs](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-generation-jobs-list): 列出測試案例生成任務
* `GET` [api/v1/test-case/generation-jobs/{jobId}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-generation-jobs-retrieve): 查詢測試案例生成任務進度
* `PUT` [api/v1/test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-update): 更新單輪測試案例
* `PATCH` [api/v1/test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-partial-update): 部分更新單輪測試案例
* `DELETE` [api/v1/test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-destroy): 刪除單輪測試案例
* `POST` [api/v1/test-case/bulk-delete](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#test-case-bulk-delete-create): 批次刪除單輪測試案例
* `GET` [api/v1/multi-turn-test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-list): 列出多輪測試案例
* `POST` [api/v1/multi-turn-test-case](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-create): 建立多輪測試案例
* `POST` [api/v1/multi-turn-test-case/generate-from-file](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-generate-from-file-create): 從知識庫檔案生成多輪測試案例
* `GET` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-retrieve): 取得特定多輪測試案例
* `PUT` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-update): 更新多輪測試案例
* `PATCH` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-partial-update): 部分更新多輪測試案例
* `DELETE` [api/v1/multi-turn-test-case/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#multi-turn-test-case-destroy): 刪除多輪測試案例
* `GET` [api/v1/evaluations/evaluation-llms](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-evaluation-llms-list): 列出可用的評估模型
* `POST` [api/v1/evaluations/evaluate](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-evaluate-create): 執行單輪評估
* `POST` [api/v1/evaluations/multi-turn-evaluate](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-multi-turn-evaluate-create): 執行多輪評估
* `GET` [api/v1/evaluations](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-list): 列出評估
* `GET` [api/v1/evaluations/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-retrieve): 取得評估結果
* `GET` [api/v1/evaluations/{id}/details](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-details-list): 取得單輪評估的逐題結果
* `GET` [api/v1/evaluations/{id}/multi-turn-results](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-multi-turn-results-list): 取得多輪評估的逐對話結果
* `POST` [api/v1/evaluations/{id}/cancel](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-cancel-create): 取消執行中的評估
* `POST` [api/v1/evaluations/{id}/resume](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-resume-create): 繼續未完成的評估
* `POST` [api/v1/evaluations/{id}/export](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-export-create): 匯出評估報表
* `GET` [api/v1/evaluations/{id}/export-status](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-export-status-retrieve): 查詢最新匯出狀態
* `GET` [api/v1/evaluations/{id}/exports](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-exports-list): 列出匯出紀錄
* `PATCH` [api/v1/evaluations/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-partial-update): 編輯評估名稱與描述
* `DELETE` [api/v1/evaluations/{id}](https://docs.maiagent.ai/api/api-reference/ping-gu-he-ce-shi-ji#evaluations-destroy): 刪除評估

### Credit

* `GET` [api/v1/credit/wallets](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-list): 查詢 Credit 餘額
* `GET` [api/v1/credit/wallets/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-retrieve): 取得錢包詳情
* `GET` [api/v1/credit/wallets/{id}/balance](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-balance-retrieve): 取得錢包餘額
* `GET` [api/v1/credit/wallets/{id}/expiring-credits](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-expiring-credits-retrieve): 查詢即將到期額度
* `GET` [api/v1/credit/wallets/{id}/topup-history](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-topup-history-retrieve): 查詢入帳紀錄
* `GET` [api/v1/credit/transactions](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-list): 列出消耗明細
* `GET` [api/v1/credit/transactions/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-retrieve): 取得單筆消耗明細
* `GET` [api/v1/credit/transactions/history](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-history-retrieve): 查詢消耗紀錄
* `GET` [api/v1/credit/transactions/history-summary](https://docs.maiagent.ai/api/api-reference/credit#credit-transactions-history-summary-retrieve): 查詢消耗總計
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-list): 查詢各分類 Credit 用量
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-retrieve): 查詢單一分類 Credit 用量
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{itemPk}/members](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-members-list): 查詢計價項目的成員用量
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{itemPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-usage-statistics-credit-categories-members-retrieve): 查詢單一成員的計價項目用量
* `GET` [api/v1/credit/wallets/{id}/new-member-quota-policy](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-new-member-quota-policy-retrieve): 取得新成員預設額度設定
* `PATCH` [api/v1/credit/wallets/{id}/new-member-quota-policy](https://docs.maiagent.ai/api/api-reference/credit#credit-wallets-new-member-quota-policy-partial-update): 更新新成員預設額度設定
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-members](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-members-list): 列出成員額度現況
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-groups](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-groups-list): 列出角色額度現況
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-inboxes](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-inboxes-list): 列出對話平台額度現況
* `GET` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-list): 列出成員的額度設定
* `GET` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-retrieve): 取得成員的單筆額度設定
* `POST` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-create): 為成員設定額度
* `PATCH` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-partial-update): 更新成員的額度設定
* `DELETE` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-members-credit-quotas-destroy): 停用成員的額度設定
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-list): 列出角色的額度設定
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-retrieve): 取得角色的單筆額度設定
* `POST` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-create): 為角色設定額度
* `PATCH` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-partial-update): 更新角色的額度設定
* `DELETE` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quotas-destroy): 停用角色的額度設定
* `PATCH` [api/v1/organizations/{organizationPk}/credit-quota-groups/{id}/credit-quota-required](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-groups-credit-quota-required-partial-update): 設定角色是否需要額度
* `GET` [api/v1/organizations/{organizationPk}/groups/{id}/credit-quota-stats](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-credit-quota-stats-retrieve): 查詢角色成員額度統計
* `POST` [api/v1/organizations/{organizationPk}/groups/{id}/batch-distribute-credit-quota](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-batch-distribute-credit-quota-create): 依角色批次分配額度
* `POST` [api/v1/organizations/{organizationPk}/groups/{id}/batch-deactivate-credit-quota](https://docs.maiagent.ai/api/api-reference/credit#organizations-groups-batch-deactivate-credit-quota-create): 依角色批次停用額度
* `GET` [api/v1/inboxes/{inboxPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-list): 列出對話平台的額度設定
* `GET` [api/v1/inboxes/{inboxPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-retrieve): 取得對話平台的單筆額度設定
* `POST` [api/v1/inboxes/{inboxPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-create): 為對話平台設定額度
* `PATCH` [api/v1/inboxes/{inboxPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-partial-update): 更新對話平台的額度設定
* `DELETE` [api/v1/inboxes/{inboxPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit#inboxes-credit-quotas-destroy): 停用對話平台的額度設定
* `PATCH` [api/v1/organizations/{organizationPk}/credit-quota-inboxes/{id}/credit-quota-required](https://docs.maiagent.ai/api/api-reference/credit#organizations-credit-quota-inboxes-credit-quota-required-partial-update): 設定對話平台是否需要額度
* `GET` [api/v1/organizations/{organizationPk}/me/credit-quota](https://docs.maiagent.ai/api/api-reference/credit#organizations-me-credit-quota-retrieve): 查詢自己的額度
* `GET` [api/v1/organizations/{organizationPk}/me/group-credit-quotas](https://docs.maiagent.ai/api/api-reference/credit#organizations-me-group-credit-quotas-retrieve): 查詢自己所屬角色的額度
* `GET` [api/v1/credit/pricing-rules](https://docs.maiagent.ai/api/api-reference/credit#credit-pricing-rules-list): 列出計價規則
* `GET` [api/v1/credit/pricing-rules/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-pricing-rules-retrieve): 取得單一計價規則
* `GET` [api/v1/credit/items](https://docs.maiagent.ai/api/api-reference/credit#credit-items-list): 列出計價項目
* `GET` [api/v1/credit/items/{id}](https://docs.maiagent.ai/api/api-reference/credit#credit-items-retrieve): 取得單一計價項目

### AI Gateway

* `GET` [api/v1/models](https://docs.maiagent.ai/api/api-reference/ai-gateway#models-retrieve): 列出可用模型
* `POST` [api/v1/chat/completions](https://docs.maiagent.ai/api/api-reference/ai-gateway#chat-completions-create): 對話補全（支援串流與工具呼叫）
* `POST` [api/v1/embeddings](https://docs.maiagent.ai/api/api-reference/ai-gateway#embeddings-create): 產生文字向量

### SCIM

* `GET` [api/v1/scim/{orgUuid}/ServiceProviderConfig](https://docs.maiagent.ai/api/api-reference/scim#scim-service-provider-config-retrieve): 取得服務提供者設定（IdP 探索用）
* `GET` [api/v1/scim/{orgUuid}/Users](https://docs.maiagent.ai/api/api-reference/scim#scim-users-retrieve): 列出或查詢成員（支援 `filter`、`startIndex`、`count`）
* `POST` [api/v1/scim/{orgUuid}/Users](https://docs.maiagent.ai/api/api-reference/scim#scim-users-create): 建立成員
* `GET` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-retrieve2): 取得特定成員
* `PUT` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-update): 整筆取代成員
* `PATCH` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-partial-update): 局部更新成員（停用、改名、改 externalId）
* `DELETE` [api/v1/scim/{orgUuid}/Users/{userId}](https://docs.maiagent.ai/api/api-reference/scim#scim-users-destroy): 停用成員
* `GET` [api/v1/scim/{orgUuid}/Groups](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-retrieve): 列出群組（對應 MaiAgent 角色）
* `POST` [api/v1/scim/{orgUuid}/Groups](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-create): 建立群組
* `GET` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-retrieve2): 取得特定群組
* `PUT` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-update): 整筆取代群組
* `PATCH` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-partial-update): 局部更新群組（改名、增減成員）
* `DELETE` [api/v1/scim/{orgUuid}/Groups/{groupId}](https://docs.maiagent.ai/api/api-reference/scim#scim-groups-destroy): 刪除群組

### 會議記錄

* `GET` [api/v1/meeting-records](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-list): 列出會議記錄
* `POST` [api/v1/meeting-records](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-create): 建立會議記錄
* `GET` [api/v1/meeting-records/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-retrieve): 取得特定會議記錄
* `PATCH` [api/v1/meeting-records/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-partial-update): 部分更新會議記錄
* `DELETE` [api/v1/meeting-records/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-destroy): 刪除會議記錄
* `POST` [api/v1/meeting-records/import-audio](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-import-audio-create): 匯入音檔並開始轉錄
* `GET` [api/v1/meeting-records/{id}/transcript](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-transcript-retrieve): 取得會議逐字稿（JSON）
* `GET` [api/v1/meeting-records/{meetingRecordPk}/summaries](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-summaries-list): 列出會議摘要
* `POST` [api/v1/meeting-records/{meetingRecordPk}/summaries/generate](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-summaries-generate-create): 產生會議摘要
* `GET` [api/v1/meeting-records/{meetingRecordPk}/summaries/{id}](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-summaries-retrieve): 取得特定會議摘要
* `POST` [api/v1/meeting-records/{id}/upload-transcript](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-upload-transcript-create): 上傳逐字稿到知識庫
* `GET` [api/v1/meeting-records/{id}/download-srt](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-download-srt-retrieve): 下載 SRT 字幕檔
* `GET` [api/v1/meeting-records/{id}/download-mp3](https://docs.maiagent.ai/api/api-reference/hui-yi-ji-lu#meeting-records-download-mp3-retrieve): 下載 MP3 音檔


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.maiagent.ai/api/preparation/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.