> 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/ja/preparation/readme.md).

# 概要

## ドキュメントの概要

MaiAgent の API エンドポイントに関するドキュメント

## API 連携のサンプルコード

API の使用例とコード全体については、次の GitHub リポジトリを参照してください：

* 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): 署名付き URL で添付ファイルをアップロード
* `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 ツールのレジストリを取得
* `GET` [api/v1/tool-execution-records](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): ツール実行履歴を一覧表示
* `GET` [api/v1/tool-execution-records/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 指定したツール実行履歴を取得
* `GET` [api/v1/tool-execution-records/chatbots](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 実行履歴の AI アシスタントのフィルター項目を取得
* `GET` [api/v1/tool-execution-records/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 実行履歴のツールのフィルター項目を取得
* `GET` [api/v1/tools/{toolPk}/tool-execution-records](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 指定したツールの実行履歴を一覧表示
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/{id}](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 指定したツールの実行履歴を取得
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/chatbots](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 指定したツールの実行履歴の AI アシスタントのフィルター項目を取得
* `GET` [api/v1/tools/{toolPk}/tool-execution-records/tools](https://docs.maiagent.ai/api/api-reference/gong-ju-he-lian-jie-qi): 指定したツールの実行履歴のツールのフィルター項目を取得

### スキル

* `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): データベース設定を削除

### Credit

* `GET` [api/v1/credit/wallets](https://docs.maiagent.ai/api/api-reference/credit): Credit 残高を照会
* `GET` [api/v1/credit/wallets/{id}](https://docs.maiagent.ai/api/api-reference/credit): ウォレットの詳細を取得
* `GET` [api/v1/credit/wallets/{id}/balance](https://docs.maiagent.ai/api/api-reference/credit): ウォレットの残高を取得
* `GET` [api/v1/credit/wallets/{id}/expiring-credits](https://docs.maiagent.ai/api/api-reference/credit): 期限が近いクレジットを照会
* `GET` [api/v1/credit/wallets/{id}/topup-history](https://docs.maiagent.ai/api/api-reference/credit): 入金履歴を照会
* `GET` [api/v1/credit/transactions](https://docs.maiagent.ai/api/api-reference/credit): 消費明細を一覧表示
* `GET` [api/v1/credit/transactions/{id}](https://docs.maiagent.ai/api/api-reference/credit): 指定した消費明細を取得
* `GET` [api/v1/credit/transactions/history](https://docs.maiagent.ai/api/api-reference/credit): 消費履歴を照会
* `GET` [api/v1/credit/transactions/history-summary](https://docs.maiagent.ai/api/api-reference/credit): 消費合計を照会
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories](https://docs.maiagent.ai/api/api-reference/credit): カテゴリ別の Credit 使用量を照会
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{id}](https://docs.maiagent.ai/api/api-reference/credit): 指定したカテゴリの Credit 使用量を照会
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{itemPk}/members](https://docs.maiagent.ai/api/api-reference/credit): 課金項目のメンバー別使用量を照会
* `GET` [api/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{itemPk}/members/{id}](https://docs.maiagent.ai/api/api-reference/credit): 指定したメンバーの課金項目別使用量を照会
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-members](https://docs.maiagent.ai/api/api-reference/credit): メンバーの現在の上限を一覧表示
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-groups](https://docs.maiagent.ai/api/api-reference/credit): ロールの現在の上限を一覧表示
* `GET` [api/v1/organizations/{organizationPk}/credit-quota-inboxes](https://docs.maiagent.ai/api/api-reference/credit): 会話プラットフォームの現在の上限を一覧表示
* `GET` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit): メンバーの上限設定を一覧表示
* `GET` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit): メンバーの指定した上限設定を取得
* `POST` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit): メンバーの上限を設定
* `PATCH` [api/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit): メンバーの上限設定を更新
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas](https://docs.maiagent.ai/api/api-reference/credit): ロールの上限設定を一覧表示
* `GET` [api/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}](https://docs.maiagent.ai/api/api-reference/credit): ロールの指定した上限設定を取得
* `GET` [api/v1/organizations/{organizationPk}/groups/{id}/credit-quota-stats](https://docs.maiagent.ai/api/api-reference/credit): ロールのメンバーの上限統計を照会
* `POST` [api/v1/organizations/{organizationPk}/groups/{id}/batch-distribute-credit-quota](https://docs.maiagent.ai/api/api-reference/credit): ロール別に上限を一括配分
* `GET` [api/v1/organizations/{organizationPk}/me/credit-quota](https://docs.maiagent.ai/api/api-reference/credit): 自分の上限を照会
* `GET` [api/v1/organizations/{organizationPk}/me/group-credit-quotas](https://docs.maiagent.ai/api/api-reference/credit): 所属するロールの上限を照会
* `GET` [api/v1/credit/pricing-rules](https://docs.maiagent.ai/api/api-reference/credit): 料金ルールを一覧表示
* `GET` [api/v1/credit/pricing-rules/{id}](https://docs.maiagent.ai/api/api-reference/credit): 指定した料金ルールを取得
* `GET` [api/v1/credit/items](https://docs.maiagent.ai/api/api-reference/credit): 課金項目を一覧表示
* `GET` [api/v1/credit/items/{id}](https://docs.maiagent.ai/api/api-reference/credit): 指定した課金項目を取得

## 認証要件

すべての API リクエストには、次の形式で HTTP ヘッダーに API Key を含めてください。

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

## 使用方法

* 各エンドポイントの詳細なドキュメントを確認してください
* 各カテゴリのページに、リクエストとレスポンスの詳細な形式が記載されています
* すべてのコード例は複数のプログラミング言語で提供されています

## ステータスコード

| ステータスコード | 説明                |
| -------- | ----------------- |
| 200      | リクエストに成功しました      |
| 201      | リソースの作成に成功しました    |
| 400      | リクエストの形式が正しくありません |
| 401      | 認証に失敗しました         |
| 403      | 権限が不足しています        |
| 404      | リソースが存在しません       |
| 500      | サーバーエラー           |


---

# 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 dynamically 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/ja/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 `build a script that syncs our docs to a CMS` 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.