# 總覽說明

## 文件概述

Documentation of API endpoints of MaiAgent

## 串接範例程式碼

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

* C# 範例
* Python 範例

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

## API 分類與端點列表

### AI 助理

* `POST` [api/v1/chatbots](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 建立新 AI 助理
* `GET` [api/v1/embedding-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 列出 Embedding Model
* `GET` [api/v1/reranker-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 列出 Reranker Model
* `GET` [api/v1/large-language-models](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 列出大型語言模型
* `GET` [api/v1/chatbots](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 取得 AI 助理列表
* `GET` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 取得特定 AI 助理
* `PUT` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 更新 AI 助理
* `PATCH` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 部分更新 AI 助理
* `DELETE` [api/v1/chatbots/{id}](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 刪除 AI 助理
* `POST` [api/v1/chatbots/{id}/duplicate](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 複製 AI 助理
* `PATCH` [api/v1/chatbots/{id}/enable-evaluation](https://docs.maiagent.ai/api/api-reference/ai-zhu-li): 啟用或停用評估功能

### 附件與檔案

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

### 知識庫（新版）

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

### 知識庫（舊版）

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

### 對話與訊息

* `POST` [api/v1/chatbots/{chatbotId}/completions](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 發送訊息 (串流)
* `POST` [api/v1/messages](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 發送訊息 (建立)
* `POST` [api/v1/messages/outgoing](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 發送主動訊息
* `POST` [api/v1/conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 建立新的對話
* `GET` [api/v1/messages](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得訊息列表
* `GET` [api/v1/messages/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得特定訊息
* `GET` [api/v1/conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得對話列表
* `GET` [api/v1/conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得特定對話
* `PATCH` [api/v1/conversations/{id}/rename](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 重新命名對話
* `POST` [api/v1/conversations/{conversationPk}/share](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 分享對話
* `POST` [api/v1/conversations/{conversationPk}/share/quick](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 快速分享對話
* `GET` [api/v1/shared-conversations](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 列出分享的對話
* `GET` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得特定分享對話
* `PATCH` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 更新分享對話
* `DELETE` [api/v1/shared-conversations/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 刪除分享對話
* `POST` [api/v1/shared-conversations/{id}/fork](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 複製分享對話
* `GET` [api/v1/shared-conversations/my-shares](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得我的分享列表
* `POST` [api/v1/messages/{messagePk}/feedback](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 建立訊息回饋
* `PUT` [api/v1/messages/{messagePk}/feedback/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 更新訊息回饋
* `DELETE` [api/v1/messages/{messagePk}/feedback/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 刪除訊息回饋
* `GET` [api/v1/records](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得對話紀錄列表
* `GET` [api/v1/records/{id}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得特定對話紀錄
* `POST` [api/v1/records/export-excel-requests](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 建立對話紀錄匯出請求
* `GET` [api/v1/records/export-excel-requests/{exportId}](https://docs.maiagent.ai/api/api-reference/dui-hua-he-xun-xi): 取得對話紀錄匯出狀態

### 對話 Widget

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

### 組織與成員

* `POST` [api/v1/auth/registration](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 帳號註冊
* `POST` [api/v1/auth/password/change](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 更換密碼
* `POST` [api/v1/organizations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 建立新組織
* `POST` [api/v1/organizations/{organizationPk}/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 新增成員至指定組織
* `GET` [api/v1/organizations](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得組織列表
* `GET` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得特定組織資訊
* `GET` [api/v1/users/current](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得當前用戶詳細資訊
* `GET` [api/v1/permissions](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得當前用戶權限
* `GET` [api/v1/organizations/{organizationPk}/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得指定組織的成員列表
* `GET` [api/v1/organizations/{organizationPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得特定成員詳細資訊
* `PUT` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 更新組織資訊
* `PUT` [api/v1/users/current](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 更新當前用戶詳細資訊
* `PUT` [api/v1/organizations/{organizationPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 更新指定組織成員資訊
* `POST` [api/v1/organizations/{organizationPk}/members/{id}/update-groups](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 更新成員所屬角色
* `DELETE` [api/v1/organizations/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 刪除組織
* `DELETE` [api/v1/organizations/{organizationPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 刪除指定成員
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/members](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得成員使用統計
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/members/summary](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得成員使用統計摘要
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/chatbots](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得 AI 助理使用統計
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/chatbots/summary](https://docs.maiagent.ai/api/api-reference/zu-zhi-he-cheng-yuan): 取得 AI 助理使用統計摘要

### 角色與權限

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

### 聯絡人

* `GET` [api/v1/contacts](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 列出聯絡人
* `POST` [api/v1/contacts](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 建立聯絡人
* `GET` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 取得聯絡人詳情
* `PUT` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 更新聯絡人
* `PATCH` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 部分更新聯絡人
* `DELETE` [api/v1/contacts/{id}](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 刪除聯絡人
* `GET` [api/v1/contacts/{id}/conversations](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 取得聯絡人的對話列表
* `GET` [api/v1/contacts/{id}/conversations/latest](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 取得聯絡人最新對話
* `POST` [api/v1/contacts/broadcast-message](https://docs.maiagent.ai/api/api-reference/lian-luo-ren): 群發訊息

### 工具與連接器

* `POST` [api/v1/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 建立工具
* `GET` [api/v1/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 列出工具
* `GET` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 取得特定工具
* `PUT` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 更新工具
* `PATCH` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 部分更新工具
* `DELETE` [api/v1/tools/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 刪除工具
* `GET` [api/v1/tools/available-tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 列出可用工具
* `POST` [api/v1/connectors](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 建立連接器
* `GET` [api/v1/connectors](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 列出連接器
* `GET` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 取得特定連接器
* `PUT` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 更新連接器
* `PATCH` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 部分更新連接器
* `DELETE` [api/v1/connectors/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 刪除連接器
* `GET` [api/v1/connectors/{id}/authorized-members](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 列出連接器授權成員
* `DELETE` [api/v1/connectors/{id}/authorized-members/{memberId}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 移除連接器授權成員
* `GET` [api/v1/mcp/registry](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 列出 MCP 工具登錄
* `GET` [api/v1/mcp/registry/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 取得特定 MCP 工具登錄

### 技能

* `POST` [api/v1/skills/upload](https://docs.maiagent.ai/api/api-reference/ji-neng): 上傳技能
* `GET` [api/v1/skills](https://docs.maiagent.ai/api/api-reference/ji-neng): 列出技能
* `GET` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng): 取得特定技能
* `PUT` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng): 更新技能
* `PATCH` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng): 部分更新技能
* `DELETE` [api/v1/skills/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng): 刪除技能
* `GET` [api/v1/skills/{id}/export](https://docs.maiagent.ai/api/api-reference/ji-neng): 匯出技能
* `POST` [api/v1/skills/{id}/reupload](https://docs.maiagent.ai/api/api-reference/ji-neng): 重新上傳技能
* `GET` [api/v1/skills/{skillPk}/resources](https://docs.maiagent.ai/api/api-reference/ji-neng): 列出技能資源
* `DELETE` [api/v1/skills/{skillPk}/resources/{id}](https://docs.maiagent.ai/api/api-reference/ji-neng): 刪除技能資源
* `GET` [api/v1/skills/{skillPk}/resources/{id}/download](https://docs.maiagent.ai/api/api-reference/ji-neng): 下載技能資源

### 資料庫

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

## 認證要求

所有 API 請求必須在 HTTP Header 中包含 API Key，格式如下：

```
Authorization: Api-Key YOUR_API_KEY
```

## 使用說明

* 請仔細閱讀每個端點的詳細文檔
* 在每個分類頁面中可以找到詳細的請求與回應格式
* 所有範例程式碼都提供了多種程式語言的版本

## 狀態碼說明

| 狀態碼 | 說明     |
| --- | ------ |
| 200 | 請求成功   |
| 201 | 資源成功建立 |
| 400 | 請求格式錯誤 |
| 401 | 認證失敗   |
| 403 | 權限不足   |
| 404 | 資源不存在  |
| 500 | 伺服器錯誤  |


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.