概要
ドキュメントの概要
MaiAgent の API エンドポイントに関するドキュメント
API 連携のサンプルコード
API の使用例とコード全体については、次の GitHub リポジトリを参照してください：
C# の例
Python の例
API のカテゴリとエンドポイント一覧
AI アシスタント
POSTapi/v1/chatbots: 新しい AI アシスタントを作成GETapi/v1/embedding-models: Embedding Model の一覧を取得GETapi/v1/reranker-models: Reranker Model の一覧を取得GETapi/v1/large-language-models: 大規模言語モデルの一覧を取得GETapi/v1/chatbots: AI アシスタントの一覧を取得GETapi/v1/chatbots/{id}: 特定の AI アシスタントを取得PUTapi/v1/chatbots/{id}: AI アシスタントを更新PATCHapi/v1/chatbots/{id}: AI アシスタントを部分更新DELETEapi/v1/chatbots/{id}: AI アシスタントを削除POSTapi/v1/chatbots/{id}/duplicate: AI アシスタントを複製PATCHapi/v1/chatbots/{id}/enable-evaluation: 評価機能を有効化または無効化
添付ファイルとファイル
POSTapi/v1/attachments-upload: 新しい添付ファイルを作成（統合）POSTapi/v1/upload-presigned-url: ファイルアップロード用の署名付き URL を取得POSTapi/v1/attachments: 署名付き URL で添付ファイルをアップロードPOSTapi/v1/conversations/{conversationPk}/attachments: 会話の添付ファイルを作成GETapi/v1/allowed-file-specs: 許可されるファイルの仕様を取得
ナレッジベース（新版）
POSTapi/v1/knowledge-bases: ナレッジベースを作成GETapi/v1/knowledge-bases: すべてのナレッジベースを一覧表示GETapi/v1/knowledge-bases/{id}: 特定のナレッジベースの詳細を取得GETapi/v1/knowledge-bases/{id}/search: 特定のナレッジベースの内容を検索PUTapi/v1/knowledge-bases/{id}: ナレッジベースを更新PATCHapi/v1/knowledge-bases/{id}: ナレッジベースを部分更新DELETEapi/v1/knowledge-bases/{id}: ナレッジベースを削除GETapi/v1/knowledge-bases/{id}/check-rrf-availability: RRF の利用可否を確認GETapi/v1/knowledge-bases/{id}/export-labels-excel: ラベルを Excel にエクスポートPOSTapi/v1/knowledge-bases/{id}/import-labels-excel: Excel からラベルをインポートGETapi/v1/knowledge-bases/{id}/export-metadata-excel: メタデータを Excel にエクスポートPOSTapi/v1/knowledge-bases/{id}/import-metadata-excel: Excel からメタデータをインポートPOSTapi/v1/knowledge-bases/{knowledgeBasePk}/labels: 新しいラベルを作成GETapi/v1/knowledge-bases/{knowledgeBasePk}/labels: ナレッジベース内のラベルを一覧表示GETapi/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}: 特定のラベルの詳細を取得PATCHapi/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}: ラベルを部分更新DELETEapi/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}: ラベルを削除POSTapi/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys: メタデータフィールドを作成GETapi/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys: メタデータフィールドを一覧表示GETapi/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}: 特定のメタデータフィールドを取得PUTapi/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}: メタデータフィールドを更新POSTapi/v1/knowledge-bases/{knowledgeBasePk}/files: ナレッジベースにファイルをアップロードPOSTapi/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/update-metadata: ファイルのメタデータを更新POSTapi/v1/knowledge-bases/{knowledgeBasePk}/files/batch-delete: ファイルを一括削除PATCHapi/v1/knowledge-bases/{knowledgeBasePk}/files/batch-reparse: ファイルを一括再解析GETapi/v1/knowledge-bases/{knowledgeBasePk}/files: ナレッジベース内のファイルを一覧表示GETapi/v1/knowledge-bases/{knowledgeBasePk}/files/{id}: 特定のファイルの詳細を取得GETapi/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/latest-failed-reason: ファイルの最新の失敗理由を取得GETapi/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/transcription: ファイルの文字起こし内容を取得PUTapi/v1/knowledge-bases/{knowledgeBasePk}/files/{id}: ファイル情報を更新PATCHapi/v1/knowledge-bases/{knowledgeBasePk}/files/{id}: ファイルを部分更新DELETEapi/v1/knowledge-bases/{knowledgeBasePk}/files/{id}: ファイルを削除GETapi/v1/knowledge-bases/{knowledgeBasePk}/documents: ナレッジベースのドキュメントを一覧表示PUTapi/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}: ドキュメントを更新PATCHapi/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}: ドキュメントを部分更新DELETEapi/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}: ドキュメントを削除POSTapi/v1/knowledge-bases/{knowledgeBasePk}/faqs: 新しい FAQ を作成POSTapi/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/update-metadata: FAQ のメタデータを更新POSTapi/v1/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete: FAQ を一括削除GETapi/v1/knowledge-bases/{knowledgeBasePk}/faqs: 特定のナレッジベースのすべての FAQ を一覧表示GETapi/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}: 特定の FAQ の詳細を取得PUTapi/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}: FAQ を更新PATCHapi/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}: FAQ を部分更新DELETEapi/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}: FAQ を削除
ナレッジベース（旧版）
GETapi/v1/chatbots/{id}/knowledge-bases-files: AI アシスタントのナレッジベースファイルを一覧表示GETapi/v1/chatbots/{id}/knowledge-bases-faqs: AI アシスタントのナレッジベース FAQ を一覧表示GETapi/v1/chatbot-text-nodes: AI アシスタントのすべてのファイルのテキストノードを取得GETapi/v1/chatbot-text-nodes/{id}: AI アシスタントの特定のファイルのテキストノードを取得POSTapi/v1/chatbots/{id}/search: 検索をテストGETapi/v1/parsers/supported-file-types: ファイル形式に対応するパーサーを一覧表示
会話とメッセージ
POSTapi/v1/chatbots/{chatbotId}/completions: メッセージを送信（ストリーミング）POSTapi/v1/messages: メッセージを送信（作成）POSTapi/v1/messages/outgoing: プロアクティブメッセージを送信POSTapi/v1/conversations: 新しい会話を作成GETapi/v1/messages: メッセージを一覧表示GETapi/v1/messages/{id}: 特定のメッセージを取得GETapi/v1/conversations: 会話を一覧表示GETapi/v1/conversations/{id}: 特定の会話を取得PATCHapi/v1/conversations/{id}/rename: 会話の名前を変更POSTapi/v1/conversations/{conversationPk}/share: 会話を共有POSTapi/v1/conversations/{conversationPk}/share/quick: 会話をすばやく共有GETapi/v1/shared-conversations: 共有された会話を一覧表示GETapi/v1/shared-conversations/{id}: 特定の共有会話を取得PATCHapi/v1/shared-conversations/{id}: 共有会話を更新DELETEapi/v1/shared-conversations/{id}: 共有会話を削除POSTapi/v1/shared-conversations/{id}/fork: 共有会話を複製GETapi/v1/shared-conversations/my-shares: 自分の共有一覧を取得POSTapi/v1/messages/{messagePk}/feedback: メッセージのフィードバックを作成PUTapi/v1/messages/{messagePk}/feedback/{id}: メッセージのフィードバックを更新DELETEapi/v1/messages/{messagePk}/feedback/{id}: メッセージのフィードバックを削除GETapi/v1/records: 会話記録を一覧表示GETapi/v1/records/{id}: 特定の会話記録を取得POSTapi/v1/records/export-excel-requests: 会話記録のエクスポートリクエストを作成GETapi/v1/records/export-excel-requests/{exportId}: 会話記録のエクスポート状態を取得
会話 Widget
POSTapi/v1/web-chats: Web Chat を作成GETapi/v1/web-chats: Web Chat を一覧表示GETapi/v1/web-chats/{id}: 特定の Web Chat を取得PUTapi/v1/web-chats/{id}: Web Chat を更新PATCHapi/v1/web-chats/{id}: Web Chat を部分更新POSTapi/v1/web-chats/{id}/setup-contact-credentials: 連絡先の認証情報を設定POSTapi/v1/web-chats/{id}/voice-agent/token: 音声アシスタントの Token を取得POSTapi/v1/web-chats/{webchatPk}/batch-qas: バッチ QA ファイルをアップロードGETapi/v1/web-chats/{webchatPk}/batch-qas/{id}/export-excel: バッチ QA を Excel にエクスポートGETapi/v1/chatbots/{chatbotPk}/llm-usage-statistics: LLM の使用統計を取得GETapi/v1/chatbots/{chatbotPk}/statistics: AI アシスタントの統計データを取得
組織とメンバー
POSTapi/v1/auth/registration: アカウントを登録POSTapi/v1/auth/password/change: パスワードを変更POSTapi/v1/organizations: 新しい組織を作成POSTapi/v1/organizations/{organizationPk}/members: 指定した組織にメンバーを追加GETapi/v1/organizations: 組織を一覧表示GETapi/v1/organizations/{id}: 特定の組織の詳細を取得GETapi/v1/users/current: 現在のユーザーの詳細を取得GETapi/v1/permissions: 現在のユーザーの権限を取得GETapi/v1/organizations/{organizationPk}/members: 指定した組織のメンバーを一覧表示GETapi/v1/organizations/{organizationPk}/members/{id}: 特定のメンバーの詳細を取得PUTapi/v1/organizations/{id}: 組織情報を更新PUTapi/v1/users/current: 現在のユーザーの詳細を更新PUTapi/v1/organizations/{organizationPk}/members/{id}: 指定した組織のメンバー情報を更新POSTapi/v1/organizations/{organizationPk}/members/{id}/update-groups: メンバーに割り当てられたロールを更新DELETEapi/v1/organizations/{id}: 組織を削除DELETEapi/v1/organizations/{organizationPk}/members/{id}: 指定したメンバーを削除GETapi/v1/organizations/{organizationPk}/usage-statistics/members: メンバーの使用統計を取得GETapi/v1/organizations/{organizationPk}/usage-statistics/members/summary: メンバーの使用統計の概要を取得GETapi/v1/organizations/{organizationPk}/usage-statistics/chatbots: AI アシスタントの使用統計を取得GETapi/v1/organizations/{organizationPk}/usage-statistics/chatbots/summary: AI アシスタントの使用統計の概要を取得
ロールと権限
POSTapi/v1/organizations/{organizationPk}/groups: ロールを作成POSTapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/bulk-create: ロールのメンバーを一括追加POSTapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/bulk-create: AI アシスタントをロールに一括割り当てPOSTapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes/bulk-create: 受信トレイをロールに一括割り当てPOSTapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases/bulk-create: ナレッジベースをロールに一括割り当てPOSTapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases/bulk-create: データベースをロールに一括割り当てGETapi/v1/permissions: 権限を一覧表示GETapi/v1/organizations/{organizationPk}/groups: ロールを一覧表示GETapi/v1/organizations/{organizationPk}/groups/{id}: ロールの詳細を取得GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-members: ロールのメンバーを一覧表示GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}: 特定のロールのメンバーを取得GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots: ロールに割り当てられた AI アシスタントを一覧表示GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes: ロールに割り当てられた受信トレイを一覧表示GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases: ロールに割り当てられたナレッジベースを一覧表示GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases: ロールに割り当てられたデータベースを一覧表示PUTapi/v1/organizations/{organizationPk}/groups/{id}: ロールの権限を更新PATCHapi/v1/organizations/{organizationPk}/groups/{id}: ロールの権限を部分更新DELETEapi/v1/organizations/{organizationPk}/groups/{id}: ロールを削除DELETEapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-members/{id}: ロールのメンバーを削除DELETEapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-chatbots/{id}: ロールから AI アシスタントを削除DELETEapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-inboxes/{id}: ロールから受信トレイを削除DELETEapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-knowledge-bases/{id}: ロールからナレッジベースを削除DELETEapi/v1/organizations/{organizationPk}/groups/{groupPk}/group-databases/{id}: ロールからデータベースを削除
連絡先
GETapi/v1/contacts: 連絡先を一覧表示POSTapi/v1/contacts: 連絡先を作成GETapi/v1/contacts/{id}: 連絡先の詳細を取得PUTapi/v1/contacts/{id}: 連絡先を更新PATCHapi/v1/contacts/{id}: 連絡先を部分更新DELETEapi/v1/contacts/{id}: 連絡先を削除GETapi/v1/contacts/{id}/conversations: 連絡先の会話を一覧表示GETapi/v1/contacts/{id}/conversations/latest: 連絡先の最新の会話を取得POSTapi/v1/contacts/broadcast-message: メッセージを一斉送信
ツールとコネクタ
POSTapi/v1/tools: ツールを作成GETapi/v1/tools: ツールを一覧表示GETapi/v1/tools/{id}: 特定のツールを取得PUTapi/v1/tools/{id}: ツールを更新PATCHapi/v1/tools/{id}: ツールを部分更新DELETEapi/v1/tools/{id}: ツールを削除GETapi/v1/tools/available-tools: 利用可能なツールを一覧表示POSTapi/v1/connectors: コネクタを作成GETapi/v1/connectors: コネクタを一覧表示GETapi/v1/connectors/{id}: 指定したコネクタを取得PUTapi/v1/connectors/{id}: コネクタを更新PATCHapi/v1/connectors/{id}: コネクタを部分更新DELETEapi/v1/connectors/{id}: コネクタを削除GETapi/v1/connectors/{id}/authorized-members: コネクタの承認済みメンバーを一覧表示DELETEapi/v1/connectors/{id}/authorized-members/{memberId}: コネクタの承認済みメンバーを削除GETapi/v1/mcp/registry: MCP ツールのレジストリを一覧表示GETapi/v1/mcp/registry/{id}: 指定した MCP ツールのレジストリを取得GETapi/v1/tool-execution-records: ツール実行履歴を一覧表示GETapi/v1/tool-execution-records/{id}: 指定したツール実行履歴を取得GETapi/v1/tool-execution-records/chatbots: 実行履歴の AI アシスタントのフィルター項目を取得GETapi/v1/tool-execution-records/tools: 実行履歴のツールのフィルター項目を取得GETapi/v1/tools/{toolPk}/tool-execution-records: 指定したツールの実行履歴を一覧表示GETapi/v1/tools/{toolPk}/tool-execution-records/{id}: 指定したツールの実行履歴を取得GETapi/v1/tools/{toolPk}/tool-execution-records/chatbots: 指定したツールの実行履歴の AI アシスタントのフィルター項目を取得GETapi/v1/tools/{toolPk}/tool-execution-records/tools: 指定したツールの実行履歴のツールのフィルター項目を取得
スキル
POSTapi/v1/skills/upload: スキルをアップロードGETapi/v1/skills: スキルを一覧表示GETapi/v1/skills/{id}: 指定したスキルを取得PUTapi/v1/skills/{id}: スキルを更新PATCHapi/v1/skills/{id}: スキルを部分更新DELETEapi/v1/skills/{id}: スキルを削除GETapi/v1/skills/{id}/export: スキルをエクスポートPOSTapi/v1/skills/{id}/reupload: スキルを再アップロードGETapi/v1/skills/{skillPk}/resources: スキルのリソースを一覧表示DELETEapi/v1/skills/{skillPk}/resources/{id}: スキルのリソースを削除GETapi/v1/skills/{skillPk}/resources/{id}/download: スキルのリソースをダウンロード
データベース
POSTapi/v1/sql-databases: SQL データベース接続を作成GETapi/v1/sql-databases: SQL データベースを一覧表示GETapi/v1/sql-databases/{id}: 指定した SQL データベースを取得PUTapi/v1/sql-databases/{id}: SQL データベースを更新PATCHapi/v1/sql-databases/{id}: SQL データベースを部分更新DELETEapi/v1/sql-databases/{id}: SQL データベースを削除POSTapi/v1/sql-databases/{id}/test-connection: データベース接続をテストPOSTapi/v1/sql-databases/{id}/upload-files: ファイルをデータベースにアップロードPOSTapi/v1/sql-databases/batch-delete: SQL データベースを一括削除GETapi/v1/sql-databases/{sqlDatabasePk}/tables: データベースのテーブルを一覧表示POSTapi/v1/sql-databases/{sqlDatabasePk}/tables: データベースのテーブルを作成GETapi/v1/sql-databases/{sqlDatabasePk}/tables/{id}: 指定したデータベースのテーブルを取得PUTapi/v1/sql-databases/{sqlDatabasePk}/tables/{id}: データベースのテーブルを更新PATCHapi/v1/sql-databases/{sqlDatabasePk}/tables/{id}: データベースのテーブルを部分更新DELETEapi/v1/sql-databases/{sqlDatabasePk}/tables/{id}: データベースのテーブルを削除POSTapi/v1/sql-databases/{sqlDatabasePk}/tables/batch-delete: データベースのテーブルを一括削除GETapi/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns: データベースのカラムを一覧表示GETapi/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}: 指定したデータベースのカラムを取得PUTapi/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}: データベースのカラムを更新PATCHapi/v1/sql-databases/{sqlDatabasePk}/tables/{tablePk}/columns/{id}: データベースのカラムを部分更新POSTapi/v1/database-connection/test: データベース接続をテスト（共通）GETapi/v1/database-examples: データベース接続文字列の例を一覧表示GETapi/v1/database-examples/{id}: 指定したデータベース接続文字列の例を取得GETapi/v1/chatbots/{chatbotPk}/databases: AI アシスタントのデータベース設定を一覧表示POSTapi/v1/chatbots/{chatbotPk}/databases: AI アシスタントにデータベース設定を追加GETapi/v1/chatbots/{chatbotPk}/databases/{id}: 指定したデータベース設定を取得PUTapi/v1/chatbots/{chatbotPk}/databases/{id}: データベース設定を更新PATCHapi/v1/chatbots/{chatbotPk}/databases/{id}: データベース設定を部分更新DELETEapi/v1/chatbots/{chatbotPk}/databases/{id}: データベース設定を削除
Credit
GETapi/v1/credit/wallets: Credit 残高を照会GETapi/v1/credit/wallets/{id}: ウォレットの詳細を取得GETapi/v1/credit/wallets/{id}/balance: ウォレットの残高を取得GETapi/v1/credit/wallets/{id}/expiring-credits: 期限が近いクレジットを照会GETapi/v1/credit/wallets/{id}/topup-history: 入金履歴を照会GETapi/v1/credit/transactions: 消費明細を一覧表示GETapi/v1/credit/transactions/{id}: 指定した消費明細を取得GETapi/v1/credit/transactions/history: 消費履歴を照会GETapi/v1/credit/transactions/history-summary: 消費合計を照会GETapi/v1/organizations/{organizationPk}/usage-statistics/credit-categories: カテゴリ別の Credit 使用量を照会GETapi/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{id}: 指定したカテゴリの Credit 使用量を照会GETapi/v1/organizations/{organizationPk}/usage-statistics/credit-categories/{itemPk}/members/{id}: 指定したメンバーの課金項目別使用量を照会GETapi/v1/organizations/{organizationPk}/credit-quota-members: メンバーの現在の上限を一覧表示GETapi/v1/organizations/{organizationPk}/credit-quota-groups: ロールの現在の上限を一覧表示GETapi/v1/organizations/{organizationPk}/credit-quota-inboxes: 会話プラットフォームの現在の上限を一覧表示GETapi/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas: メンバーの上限設定を一覧表示GETapi/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}: メンバーの指定した上限設定を取得PATCHapi/v1/organizations/{organizationPk}/members/{memberPk}/credit-quotas/{id}: メンバーの上限設定を更新GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas: ロールの上限設定を一覧表示GETapi/v1/organizations/{organizationPk}/groups/{groupPk}/credit-quotas/{id}: ロールの指定した上限設定を取得GETapi/v1/organizations/{organizationPk}/groups/{id}/credit-quota-stats: ロールのメンバーの上限統計を照会GETapi/v1/organizations/{organizationPk}/me/credit-quota: 自分の上限を照会GETapi/v1/organizations/{organizationPk}/me/group-credit-quotas: 所属するロールの上限を照会GETapi/v1/credit/pricing-rules: 料金ルールを一覧表示GETapi/v1/credit/pricing-rules/{id}: 指定した料金ルールを取得GETapi/v1/credit/items: 課金項目を一覧表示GETapi/v1/credit/items/{id}: 指定した課金項目を取得
認証要件
すべての API リクエストには、次の形式で HTTP ヘッダーに API Key を含めてください。
使用方法
各エンドポイントの詳細なドキュメントを確認してください
各カテゴリのページに、リクエストとレスポンスの詳細な形式が記載されています
すべてのコード例は複数のプログラミング言語で提供されています
ステータスコード
200
リクエストに成功しました
201
リソースの作成に成功しました
400
リクエストの形式が正しくありません
401
認証に失敗しました
403
権限が不足しています
404
リソースが存在しません
500
サーバーエラー
最終更新
役に立ちましたか？