概要説明
ドキュメント概要
Documentation of API endpoints of MaiAgent
連携サンプルコード
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: Presignedによる添付ファイルのアップロード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: ナレッジベース文書の一覧取得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の詳細取得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-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ツールレジストリの取得
スキル
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: テーブルの一括削除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}: データベース設定の削除
認証要件
すべてのAPIリクエストには、HTTP Headerに以下の形式でAPI Keyを含める必要があります。
利用方法
各エンドポイントの詳細ドキュメントを十分にお読みください
各カテゴリページで、詳細なリクエストおよびレスポンスの形式をご確認いただけます
すべてのサンプルコードには複数のプログラミング言語のバージョンが用意されています
ステータスコードの説明
200
リクエスト成功
201
リソースの作成成功
400
リクエスト形式エラー
401
認証失敗
403
権限不足
404
リソースが存在しません
500
サーバーエラー
Last updated
Was this helpful?