クイックスタート
MaiAgent プラットフォーム API の呼び出しを始めるために、ベース URL、API キーの取得方法（メンバー自身による作成と管理者による発行）、キーの権限範囲、および最初のリクエスト例を説明します。
このページでは、プラットフォーム API を呼び出すための準備として、URL の確認、API キーの取得、最初のリクエストの送信までをご案内します。各エンドポイントのフィールドと完全な例は API ドキュメント を参照してください。認証、レート制限、エラー形式など、エンドポイント共通のルールについては API 共通規約 を参照してください。
API 連携ドキュメントとサンプルコード
API のベース URL
オンプレミスおよびプライベートクラウド環境では、貴社のプラットフォームのドメインに置き換えてください。新しい連携では必ず /api/v1/ プレフィックスを使用してください。詳細は URL とバージョンプレフィックス を参照してください。
API キーの取得
API キーの取得方法は 2 種類あり、どちらのキーも呼び出し方法は同じです。
メンバー自身による作成
組織内の有効なメンバーは、追加の権限なしで、管理画面の右上のアバター → アカウント → API キー から自分用のキーを作成できます。キーは現在切り替えている組織に作成され、キー全体が表示されるのは作成時の一度だけです。操作手順は、ユーザーマニュアルの メンバー自身によるキーの作成 を参照してください。
管理者による発行
「API Key 管理権限」を持つ管理者は、組織設定 → API Key 管理 から、指定したメンバー用のキーを発行できます。有効期限や 1 分あたりのリクエスト数（RPM）の設定、キーの無効化や取り消しもできます。操作手順は、ユーザーマニュアルの API Key の作成 を参照してください。
キーの権限範囲
キーは 1 人のメンバーに紐付きます。呼び出し時の組織と権限は、そのメンバーの組織内での身分とロール権限に基づきます。リクエストに組織 ID を別途含める必要はなく、エンドポイント別の権限スコープもありません。メンバーが無効化されるか組織から削除されると、キーは直ちに無効になります。詳細なルールと連携用キーの推奨事項は API 共通規約：認証 を参照してください。
最初のリクエストの送信
Authorization ヘッダーに Api-Key <キー> の形式でキーを指定してください（Bearer ではありません）。
Agent の一覧を取得する例です。
レスポンスはページネーション形式（count、next、previous、results）で、すべてのフィールド名は camelCase です。詳細は ページネーション と フィールド形式 を参照してください。401 が返された場合は、キーの状態とヘッダーの形式を確認してください。エラーレスポンス を参照してください。
次のステップ
エンドポイントと認証の詳細：API ドキュメント：API 認証方式
エンドポイント共通のルール：API 共通規約
会話の作成とメッセージ・添付ファイルの送信：会話とメッセージの作成
Agent の応答の取得（ストリーミングまたは同期）：会話とメッセージの応答（ストリーミング／同期）
ナレッジベースのファイルと検索の管理：ナレッジベースの利用—アップロード、検索、管理
会話イベントを自社システムに送信：Webhook
最終更新
役に立ちましたか？