> 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/api-doc-ja/api-reference/zu-zhi-he-cheng-yuan.md). # 組織とメンバー ### アカウント登録 POST `/api/auth/registration/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------- | ------------------------------- | --- | -- | | email | string (email) | はい | | | password1 | string | はい | | | password2 | string | はい | | | name | string | はい | | | company | string | はい | | | referralCode | string | いいえ | | | authSource | object (2 個のプロパティを含む: id, name) | いいえ | | | authSource.id | string (uuid) | はい | | **リクエスト構造の例** ```typescript { "email": string (email) "password1": string "password2": string "name": string "company": string "referralCode"?: string // 任意 "authSource"?: // 任意 { "id": string (uuid) } } ``` **リクエストのサンプル値** ```json { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/auth/registration/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } }; axios.post("https://api.maiagent.ai/api/auth/registration/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/auth/registration/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/auth/registration/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 201** **レスポンス構造の例** ```typescript { "detail": string } ``` **レスポンスのサンプル値** ```json { "detail": "レスポンス文字列" } ``` *** ### アカウント登録 POST `/api/v1/auth/registration/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------- | ------------------------------- | --- | -- | | email | string (email) | はい | | | password1 | string | はい | | | password2 | string | はい | | | name | string | はい | | | company | string | はい | | | referralCode | string | いいえ | | | authSource | object (2 個のプロパティを含む: id, name) | いいえ | | | authSource.id | string (uuid) | はい | | **リクエスト構造の例** ```typescript { "email": string (email) "password1": string "password2": string "name": string "company": string "referralCode"?: string // 任意 "authSource"?: // 任意 { "id": string (uuid) } } ``` **リクエストのサンプル値** ```json { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/v1/auth/registration/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } }; axios.post("https://api.maiagent.ai/api/v1/auth/registration/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/auth/registration/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/v1/auth/registration/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "email": "user@example.com", "password1": "サンプル文字列", "password2": "サンプル文字列", "name": "サンプル名", "company": "サンプル文字列", "referralCode": "サンプル文字列", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000" } } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 201** **レスポンス構造の例** ```typescript { "detail": string } ``` **レスポンスのサンプル値** ```json { "detail": "レスポンス文字列" } ``` *** ### パスワードの変更 POST `/api/auth/password/change/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------ | ------ | -- | -- | | oldPassword | string | はい | | | newPassword1 | string | はい | | | newPassword2 | string | はい | | **リクエスト構造の例** ```typescript { "oldPassword": string "newPassword1": string "newPassword2": string } ``` **リクエストのサンプル値** ```json { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/auth/password/change/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" }; axios.post("https://api.maiagent.ai/api/auth/password/change/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/auth/password/change/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/auth/password/change/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "detail": string } ``` **レスポンスのサンプル値** ```json { "detail": "レスポンス文字列" } ``` *** ### パスワードの変更 POST `/api/v1/auth/password/change/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------ | ------ | -- | -- | | oldPassword | string | はい | | | newPassword1 | string | はい | | | newPassword2 | string | はい | | **リクエスト構造の例** ```typescript { "oldPassword": string "newPassword1": string "newPassword2": string } ``` **リクエストのサンプル値** ```json { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/v1/auth/password/change/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" }; axios.post("https://api.maiagent.ai/api/v1/auth/password/change/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/auth/password/change/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/v1/auth/password/change/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "oldPassword": "サンプル文字列", "newPassword1": "サンプル文字列", "newPassword2": "サンプル文字列" } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "detail": string } ``` **レスポンスのサンプル値** ```json { "detail": "レスポンス文字列" } ``` *** ### 新規組織の作成 POST `/api/organizations/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------- | --------------- | --- | --------------------------- | | name | string | はい | 組織名 | | compact\_logo | string (binary) | いいえ | コンパクト版 Logo（任意、企業プランのみ利用可能） | | full\_logo | string (binary) | いいえ | フル版 Logo（任意、企業プランのみ利用可能） | **リクエスト構造の例** ```typescript { "name": string // 組織名 "compact_logo"?: string (binary) // コンパクト版 Logo（任意、企業プランのみ利用可能） (任意) "full_logo"?: string (binary) // フル版 Logo（任意、企業プランのみ利用可能） (任意) } ``` **リクエストのサンプル値** ```json { "name": "My Organization" } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/organizations/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "My Organization" }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "name": "My Organization" }; axios.post("https://api.maiagent.ai/api/organizations/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "name": "My Organization" } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/organizations/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "name": "My Organization" } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 201** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "createdAt": string (timestamp) "compactLogo"?: string (uri) // 任意 "fullLogo"?: string (uri) // 任意 "themePrimaryColor"?: string // UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） (任意) "usageStatistics": object "organizationPlan": object "creditWallet": object // Return credit wallet with ID only. "maigptInboxId": string (uuid) "canUseCustomElasticsearch": boolean // Allow this organization to configure custom Elasticsearch endpoints for knowledge bases. "canUseVoiceAgent": boolean // Allow this organization to use voice agent features. "canUseMeetingRecords": boolean // Allow this organization to use meeting records features. "canUseCallCenter": boolean // Allow this organization to use call center features. "isTrial": boolean // 試用期間かどうか。判定ロジック: 組織が試用プランを 1 つだけ持ち、かつ現在有効である場合 "expirationDays": integer // 経過日数。正の数=超過した日数、null=未期限または無期限プラン "showTrialBanner": boolean // フロントエンドで試用/無料プランのバナーを表示するかどうかを制御します } ``` **レスポンスのサンプル値** ```json { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "My Organization", "createdAt": "1748336288000", "compactLogo": null, "fullLogo": null, "usageStatistics": { "chatbotsCount": 0, "canCreateChatbot": true, "hasCreateChatbotLimit": true, "currentMonthWordsCountTotal": 1000000, "currentMonthUsedWordsCountTotal": 0, "currentMonthUsedConversationsCountTotal": 0, "availableUploadFilesSizeTotal": 104857600, "usedUploadFileSizeTotal": 0 }, "organizationPlan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "planName": "無料プラン", "planType": "free", "expiredAt": null }, "maigptInboxId": null, "canUseCustomElasticsearch": false, "isTrial": true, "expirationDays": null } ``` *** ### 新規組織の作成 POST `/api/v1/organizations/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------- | --------------- | --- | --------------------------- | | name | string | はい | 組織名 | | compact\_logo | string (binary) | いいえ | コンパクト版 Logo（任意、企業プランのみ利用可能） | | full\_logo | string (binary) | いいえ | フル版 Logo（任意、企業プランのみ利用可能） | **リクエスト構造の例** ```typescript { "name": string // 組織名 "compact_logo"?: string (binary) // コンパクト版 Logo（任意、企業プランのみ利用可能） (任意) "full_logo"?: string (binary) // フル版 Logo（任意、企業プランのみ利用可能） (任意) } ``` **リクエストのサンプル値** ```json { "name": "My Organization" } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/v1/organizations/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "My Organization" }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "name": "My Organization" }; axios.post("https://api.maiagent.ai/api/v1/organizations/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "name": "My Organization" } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/v1/organizations/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "name": "My Organization" } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 201** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "createdAt": string (timestamp) "compactLogo"?: string (uri) // 任意 "fullLogo"?: string (uri) // 任意 "themePrimaryColor"?: string // UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） (任意) "usageStatistics": object "organizationPlan": object "creditWallet": object // Return credit wallet with ID only. "maigptInboxId": string (uuid) "canUseCustomElasticsearch": boolean // Allow this organization to configure custom Elasticsearch endpoints for knowledge bases. "canUseVoiceAgent": boolean // Allow this organization to use voice agent features. "canUseMeetingRecords": boolean // Allow this organization to use meeting records features. "canUseCallCenter": boolean // Allow this organization to use call center features. "isTrial": boolean // 試用期間かどうか。判定ロジック: 組織が試用プランを 1 つだけ持ち、かつ現在有効である場合 "expirationDays": integer // 経過日数。正の数=超過した日数、null=未期限または無期限プラン "showTrialBanner": boolean // フロントエンドで試用/無料プランのバナーを表示するかどうかを制御します } ``` **レスポンスのサンプル値** ```json { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "My Organization", "createdAt": "1748336288000", "compactLogo": null, "fullLogo": null, "usageStatistics": { "chatbotsCount": 0, "canCreateChatbot": true, "hasCreateChatbotLimit": true, "currentMonthWordsCountTotal": 1000000, "currentMonthUsedWordsCountTotal": 0, "currentMonthUsedConversationsCountTotal": 0, "availableUploadFilesSizeTotal": 104857600, "usedUploadFileSizeTotal": 0 }, "organizationPlan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "planName": "無料プラン", "planType": "free", "expiredAt": null }, "maigptInboxId": null, "canUseCustomElasticsearch": false, "isTrial": true, "expirationDays": null } ``` *** ### 指定した組織へのメンバーの追加 POST `/api/organizations/{organizationPk}/members/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------ | -------------- | --- | -- | | email | string (email) | はい | | | organization | string (uuid) | いいえ | | **リクエスト構造の例** ```typescript { "email": string (email) "organization"?: string (uuid) // 任意 } ``` **リクエストのサンプル値** ```json { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false }; axios.post("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 201** **レスポンス構造の例** ```typescript { "organization": string (uuid) // 組織 ID "is_owner": boolean // 組織のオーナーかどうか } ``` **レスポンスのサンプル値** ```json { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } ``` *** ### 指定した組織へのメンバーの追加 POST `/api/v1/organizations/{organizationPk}/members/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------------ | -------------- | --- | -- | | email | string (email) | はい | | | organization | string (uuid) | いいえ | | **リクエスト構造の例** ```typescript { "email": string (email) "organization"?: string (uuid) // 任意 } ``` **リクエストのサンプル値** ```json { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false }; axios.post("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 201** **レスポンス構造の例** ```typescript { "organization": string (uuid) // 組織 ID "is_owner": boolean // 組織のオーナーかどうか } ``` **レスポンスのサンプル値** ```json { "organization": "613c86f7-a45f-4e29-b255-29caff89de32", "is_owner": false } ``` *** ### 組織一覧の取得 GET `/api/organizations/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ------------ | -- | ------- | ---------------------------------------------- | | `page` | ❌ | integer | A page number within the paginated result set. | | `pageSize` | ❌ | integer | Number of results to return per page. | | `pagination` | ❌ | string | ページネーションするかどうか (true/false) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/?page=1&pageSize=1&pagination=example" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/?page=1&pageSize=1&pagination=example", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/?page=1&pageSize=1&pagination=example" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/?page=1&pageSize=1&pagination=example", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "id": string (uuid) "name": string "createdAt": string (timestamp) "memberCreatedAt": string (timestamp) } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "createdAt": "レスポンス文字列", "memberCreatedAt": "レスポンス文字列" } ] } ``` *** ### 組織一覧の取得 GET `/api/v1/organizations/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ------------ | -- | ------- | ---------------------------------------------- | | `page` | ❌ | integer | A page number within the paginated result set. | | `pageSize` | ❌ | integer | Number of results to return per page. | | `pagination` | ❌ | string | ページネーションするかどうか (true/false) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/?page=1&pageSize=1&pagination=example" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/?page=1&pageSize=1&pagination=example", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/?page=1&pageSize=1&pagination=example" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/?page=1&pageSize=1&pagination=example", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "id": string (uuid) "name": string "createdAt": string (timestamp) "memberCreatedAt": string (timestamp) } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "createdAt": "レスポンス文字列", "memberCreatedAt": "レスポンス文字列" } ] } ``` *** ### 特定組織の情報の取得 GET `/api/organizations/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ------ | -- | ------ | ---------------------------------- | | `id` | ✅ | string | A UUID string identifying this 組織. | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "createdAt": string (timestamp) "compactLogo"?: string (uri) // 任意 "fullLogo"?: string (uri) // 任意 "themePrimaryColor"?: string // UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） (任意) "usageStatistics": object "organizationPlan": object "creditWallet": object // Return credit wallet with ID only. "maigptInboxId": string (uuid) "canUseCustomElasticsearch": boolean // Allow this organization to configure custom Elasticsearch endpoints for knowledge bases. "canUseVoiceAgent": boolean // Allow this organization to use voice agent features. "canUseMeetingRecords": boolean // Allow this organization to use meeting records features. "canUseCallCenter": boolean // Allow this organization to use call center features. "isTrial": boolean // 試用期間かどうか。判定ロジック: 組織が試用プランを 1 つだけ持ち、かつ現在有効である場合 "expirationDays": integer // 経過日数。正の数=超過した日数、null=未期限または無期限プラン "showTrialBanner": boolean // フロントエンドで試用/無料プランのバナーを表示するかどうかを制御します } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "createdAt": "レスポンス文字列", "compactLogo": "https://example.com/file.jpg", "fullLogo": "https://example.com/file.jpg", "themePrimaryColor": "レスポンス文字列", "usageStatistics": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "organizationPlan": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "creditWallet": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "maigptInboxId": "550e8400-e29b-41d4-a716-446655440000", "canUseCustomElasticsearch": false, "canUseVoiceAgent": false, "canUseMeetingRecords": false, "canUseCallCenter": false, "isTrial": false, "expirationDays": 456, "showTrialBanner": false } ``` *** ### 特定組織の情報の取得 GET `/api/v1/organizations/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ------ | -- | ------ | ---------------------------------- | | `id` | ✅ | string | A UUID string identifying this 組織. | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "createdAt": string (timestamp) "compactLogo"?: string (uri) // 任意 "fullLogo"?: string (uri) // 任意 "themePrimaryColor"?: string // UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） (任意) "usageStatistics": object "organizationPlan": object "creditWallet": object // Return credit wallet with ID only. "maigptInboxId": string (uuid) "canUseCustomElasticsearch": boolean // Allow this organization to configure custom Elasticsearch endpoints for knowledge bases. "canUseVoiceAgent": boolean // Allow this organization to use voice agent features. "canUseMeetingRecords": boolean // Allow this organization to use meeting records features. "canUseCallCenter": boolean // Allow this organization to use call center features. "isTrial": boolean // 試用期間かどうか。判定ロジック: 組織が試用プランを 1 つだけ持ち、かつ現在有効である場合 "expirationDays": integer // 経過日数。正の数=超過した日数、null=未期限または無期限プラン "showTrialBanner": boolean // フロントエンドで試用/無料プランのバナーを表示するかどうかを制御します } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "createdAt": "レスポンス文字列", "compactLogo": "https://example.com/file.jpg", "fullLogo": "https://example.com/file.jpg", "themePrimaryColor": "レスポンス文字列", "usageStatistics": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "organizationPlan": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "creditWallet": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "maigptInboxId": "550e8400-e29b-41d4-a716-446655440000", "canUseCustomElasticsearch": false, "canUseVoiceAgent": false, "canUseMeetingRecords": false, "canUseCallCenter": false, "isTrial": false, "expirationDays": 456, "showTrialBanner": false } ``` *** ### 現在のユーザーの詳細情報の取得 GET `/api/users/current/` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/users/current/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/users/current/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/users/current/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/users/current/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "avatar"?: string (uri) // 任意 "name": string "email": string (email) "authSource": { "id": string (uuid) "name": string } "company"?: string // 任意 "invitationCode"?: string // 任意 "apiKeys": [ // 指定した組織におけるユーザーの API キー一覧を取得します。 処理の流れ: 1. request から現在の組織インスタンスを取得します 2. 組織インスタンスが存在しない場合（通常はサードパーティ SSO ログイン時に発生）、ユーザーの認証ソースを通じて その認証ソースのデフォルト組織を検索します（is_auth_source_default_organization=True） 注意: - サードパーティ SSO ログイン時、request には organization_instance が含まれません - auth_source と is_auth_source_default_organization のフラグを通じて組織を特定する必要があります object ] "permissions": object // 現在の組織におけるユーザーの権限を取得します（親子のネスト構造）。 "resourcePermissions": object // 現在の組織におけるユーザーのリソース作成権限を取得します。 } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "avatar": "https://example.com/file.jpg", "name": "レスポンス文字列", "email": "response@example.com", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列" }, "company": "レスポンス文字列", "invitationCode": "レスポンス文字列", "apiKeys": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "permissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "resourcePermissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } } ``` *** ### 現在のユーザーの詳細情報の取得 GET `/api/v1/users/current/` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/users/current/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/users/current/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/users/current/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/users/current/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "avatar"?: string (uri) // 任意 "name": string "email": string (email) "authSource": { "id": string (uuid) "name": string } "company"?: string // 任意 "invitationCode"?: string // 任意 "apiKeys": [ // 指定した組織におけるユーザーの API キー一覧を取得します。 処理の流れ: 1. request から現在の組織インスタンスを取得します 2. 組織インスタンスが存在しない場合（通常はサードパーティ SSO ログイン時に発生）、ユーザーの認証ソースを通じて その認証ソースのデフォルト組織を検索します（is_auth_source_default_organization=True） 注意: - サードパーティ SSO ログイン時、request には organization_instance が含まれません - auth_source と is_auth_source_default_organization のフラグを通じて組織を特定する必要があります object ] "permissions": object // 現在の組織におけるユーザーの権限を取得します（親子のネスト構造）。 "resourcePermissions": object // 現在の組織におけるユーザーのリソース作成権限を取得します。 } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "avatar": "https://example.com/file.jpg", "name": "レスポンス文字列", "email": "response@example.com", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列" }, "company": "レスポンス文字列", "invitationCode": "レスポンス文字列", "apiKeys": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "permissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "resourcePermissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } } ``` *** ### 現在のユーザーの権限の取得 GET `/api/permissions/` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/permissions/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/permissions/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/permissions/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/permissions/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript [ { "id": string (uuid) "name": string "value": string "description": string "children": [ object ] } ] ``` **レスポンスのサンプル値** ```json [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "value": "レスポンス文字列", "description": "レスポンス文字列", "children": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ] } ] ``` *** ### 現在のユーザーの権限の取得 GET `/api/v1/permissions/` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/permissions/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/permissions/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/permissions/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/permissions/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript [ { "id": string (uuid) "name": string "value": string "description": string "children": [ object ] } ] ``` **レスポンスのサンプル値** ```json [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "value": "レスポンス文字列", "description": "レスポンス文字列", "children": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ] } ] ``` *** ### 指定した組織のメンバー一覧の取得 GET `/api/organizations/{organizationPk}/members/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------- | ---------------------------------------------- | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `group` | ❌ | string | | | `page` | ❌ | integer | A page number within the paginated result set. | | `pageSize` | ❌ | integer | Number of results to return per page. | | `pagination` | ❌ | string | ページネーションするかどうか (true/false) | | `query` | ❌ | string | | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "id": string (uuid) "name": string "email": string "isOwner": boolean // メンバーが組織のオーナーかどうかを確認します（OWNER Group を通じて） 同一 request 内での重複クエリを避けるためにキャッシュを使用します キャッシュの有効期間: member instance が存在する間は有効です 重複クエリを避けるため、annotation の結果があればそれを優先して使用します "permissions": [ object ] "groups": [ object ] "createdAt": string (timestamp) } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "email": "レスポンス文字列", "isOwner": false, "permissions": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "groups": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "createdAt": "レスポンス文字列" } ] } ``` *** ### 指定した組織のメンバー一覧の取得 GET `/api/v1/organizations/{organizationPk}/members/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------- | ---------------------------------------------- | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `group` | ❌ | string | | | `page` | ❌ | integer | A page number within the paginated result set. | | `pageSize` | ❌ | integer | Number of results to return per page. | | `pagination` | ❌ | string | ページネーションするかどうか (true/false) | | `query` | ❌ | string | | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/?group=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "id": string (uuid) "name": string "email": string "isOwner": boolean // メンバーが組織のオーナーかどうかを確認します（OWNER Group を通じて） 同一 request 内での重複クエリを避けるためにキャッシュを使用します キャッシュの有効期間: member instance が存在する間は有効です 重複クエリを避けるため、annotation の結果があればそれを優先して使用します "permissions": [ object ] "groups": [ object ] "createdAt": string (timestamp) } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "email": "レスポンス文字列", "isOwner": false, "permissions": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "groups": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "createdAt": "レスポンス文字列" } ] } ``` *** ### 特定メンバーの詳細情報の取得 GET `/api/organizations/{organizationPk}/members/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `id` | ✅ | string | A UUID string identifying this 成員. | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "email": string "isOwner": boolean // メンバーが組織のオーナーかどうかを確認します（OWNER Group を通じて） 同一 request 内での重複クエリを避けるためにキャッシュを使用します キャッシュの有効期間: member instance が存在する間は有効です 重複クエリを避けるため、annotation の結果があればそれを優先して使用します "permissions": [ object ] "groups": [ object ] "createdAt": string (timestamp) } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "email": "レスポンス文字列", "isOwner": false, "permissions": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "groups": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "createdAt": "レスポンス文字列" } ``` *** ### 特定メンバーの詳細情報の取得 GET `/api/organizations/{organizationPk}/members/export/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript string (binary) ``` **レスポンスのサンプル値** ```json "レスポンス文字列" ``` *** ### 特定メンバーの詳細情報の取得 GET `/api/organizations/{organizationPk}/members/export-template/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript string (binary) ``` **レスポンスのサンプル値** ```json "レスポンス文字列" ``` *** ### 特定メンバーの詳細情報の取得 GET `/api/v1/organizations/{organizationPk}/members/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `id` | ✅ | string | A UUID string identifying this 成員. | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "email": string "isOwner": boolean // メンバーが組織のオーナーかどうかを確認します（OWNER Group を通じて） 同一 request 内での重複クエリを避けるためにキャッシュを使用します キャッシュの有効期間: member instance が存在する間は有効です 重複クエリを避けるため、annotation の結果があればそれを優先して使用します "permissions": [ object ] "groups": [ object ] "createdAt": string (timestamp) } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "email": "レスポンス文字列", "isOwner": false, "permissions": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "groups": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "createdAt": "レスポンス文字列" } ``` *** ### 特定メンバーの詳細情報の取得 GET `/api/v1/organizations/{organizationPk}/members/export/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript string (binary) ``` **レスポンスのサンプル値** ```json "レスポンス文字列" ``` *** ### 特定メンバーの詳細情報の取得 GET `/api/v1/organizations/{organizationPk}/members/export-template/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/export-template/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript string (binary) ``` **レスポンスのサンプル値** ```json "レスポンス文字列" ``` *** ### 組織情報の更新 PUT `/api/organizations/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ------ | -- | ------ | ---------------------------------- | | `id` | ✅ | string | A UUID string identifying this 組織. | #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ----------------- | ------------ | --- | -------------------------------------------------- | | name | string | はい | | | compactLogo | string (uri) | いいえ | | | fullLogo | string (uri) | いいえ | | | themePrimaryColor | string | いいえ | UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） | **リクエスト構造の例** ```typescript { "name": string "compactLogo"?: string (uri) // 任意 "fullLogo"?: string (uri) // 任意 "themePrimaryColor"?: string // UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） (任意) } ``` **リクエストのサンプル値** ```json { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X PUT "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null }; axios.put("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } response = requests.put(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php put("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) // 組織 ID "name": string // 組織名 "created_at": string (timestamp) // 作成タイムスタンプ "usage_statistics": { // 利用統計情報 { "chatbots_count"?: integer // チャットボット数 (任意) "can_create_chatbot"?: boolean // チャットボットを作成できるかどうか (任意) "has_create_chatbot_limit"?: boolean // チャットボット作成の上限があるかどうか (任意) "current_month_words_count_total"?: integer // 今月の総文字数の上限 (任意) "current_month_used_words_count_total"?: integer // 今月の使用済み文字数 (任意) "current_month_used_conversations_count_total"?: integer // 今月の使用済み会話数 (任意) "available_upload_files_size_total"?: integer // アップロード可能なファイルの合計サイズ（バイト） (任意) "used_upload_file_size_total"?: integer // アップロード済みファイルのサイズ（バイト） (任意) } } "organization_plan": { // 組織プラン情報 { "id"?: string (uuid) // プラン ID (任意) "plan_name"?: string // プラン名 (任意) "expired_at"?: string (date-time) // 有効期限 (任意) } } "is_trial"?: boolean // 試用期間かどうか。判定ロジック: 組織が試用プランを 1 つだけ持ち、かつ現在有効である場合 (任意) "expiration_days"?: integer // 経過日数。正の数=超過した日数、null=未期限または無期限プラン (任意) } ``` **レスポンスのサンプル値** ```json { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } ``` *** ### 組織情報の更新 PUT `/api/v1/organizations/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ------ | -- | ------ | ---------------------------------- | | `id` | ✅ | string | A UUID string identifying this 組織. | #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ----------------- | ------------ | --- | -------------------------------------------------- | | name | string | はい | | | compactLogo | string (uri) | いいえ | | | fullLogo | string (uri) | いいえ | | | themePrimaryColor | string | いいえ | UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） | **リクエスト構造の例** ```typescript { "name": string "compactLogo"?: string (uri) // 任意 "fullLogo"?: string (uri) // 任意 "themePrimaryColor"?: string // UI テーマカラー。ボタンやリンクなどの要素の色に使用されます（HEX 形式、例: #0960bd） (任意) } ``` **リクエストのサンプル値** ```json { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X PUT "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null }; axios.put("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } response = requests.put(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php put("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) // 組織 ID "name": string // 組織名 "created_at": string (timestamp) // 作成タイムスタンプ "usage_statistics": { // 利用統計情報 { "chatbots_count"?: integer // チャットボット数 (任意) "can_create_chatbot"?: boolean // チャットボットを作成できるかどうか (任意) "has_create_chatbot_limit"?: boolean // チャットボット作成の上限があるかどうか (任意) "current_month_words_count_total"?: integer // 今月の総文字数の上限 (任意) "current_month_used_words_count_total"?: integer // 今月の使用済み文字数 (任意) "current_month_used_conversations_count_total"?: integer // 今月の使用済み会話数 (任意) "available_upload_files_size_total"?: integer // アップロード可能なファイルの合計サイズ（バイト） (任意) "used_upload_file_size_total"?: integer // アップロード済みファイルのサイズ（バイト） (任意) } } "organization_plan": { // 組織プラン情報 { "id"?: string (uuid) // プラン ID (任意) "plan_name"?: string // プラン名 (任意) "expired_at"?: string (date-time) // 有効期限 (任意) } } "is_trial"?: boolean // 試用期間かどうか。判定ロジック: 組織が試用プランを 1 つだけ持ち、かつ現在有効である場合 (任意) "expiration_days"?: integer // 経過日数。正の数=超過した日数、null=未期限または無期限プラン (任意) } ``` **レスポンスのサンプル値** ```json { "id": "5b01e0b9-0b0e-4079-8150-d12015576d2c", "name": "Updated Org Name", "created_at": "1748336288000", "usage_statistics": { "chatbots_count": 0, "can_create_chatbot": true, "has_create_chatbot_limit": true, "current_month_words_count_total": 1000000, "current_month_used_words_count_total": 0, "current_month_used_conversations_count_total": 0, "available_upload_files_size_total": 104857600, "used_upload_file_size_total": 0 }, "organization_plan": { "id": "cac825e8-cb9b-4a16-b440-4ff6b2e73911", "plan_name": "無料プラン", "expired_at": null }, "is_trial": false, "expiration_days": null } ``` *** ### 現在のユーザーの詳細情報の更新 PUT `/api/users/current/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | -------------- | -------------- | --- | -- | | avatar | string (uri) | いいえ | | | name | string | はい | | | email | string (email) | はい | | | company | string | いいえ | | | invitationCode | string | いいえ | | **リクエスト構造の例** ```typescript { "avatar"?: string (uri) // 任意 "name": string "email": string (email) "company"?: string // 任意 "invitationCode"?: string // 任意 } ``` **リクエストのサンプル値** ```json { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X PUT "https://api.maiagent.ai/api/users/current/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" }; axios.put("https://api.maiagent.ai/api/users/current/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/users/current/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" } response = requests.put(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php put("https://api.maiagent.ai/api/users/current/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "avatar"?: string (uri) // 任意 "name": string "email": string (email) "authSource": { "id": string (uuid) "name": string } "company"?: string // 任意 "invitationCode"?: string // 任意 "apiKeys": [ // 指定した組織におけるユーザーの API キー一覧を取得します。 処理の流れ: 1. request から現在の組織インスタンスを取得します 2. 組織インスタンスが存在しない場合（通常はサードパーティ SSO ログイン時に発生）、ユーザーの認証ソースを通じて その認証ソースのデフォルト組織を検索します（is_auth_source_default_organization=True） 注意: - サードパーティ SSO ログイン時、request には organization_instance が含まれません - auth_source と is_auth_source_default_organization のフラグを通じて組織を特定する必要があります object ] "permissions": object // 現在の組織におけるユーザーの権限を取得します（親子のネスト構造）。 "resourcePermissions": object // 現在の組織におけるユーザーのリソース作成権限を取得します。 } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "avatar": "https://example.com/file.jpg", "name": "レスポンス文字列", "email": "response@example.com", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列" }, "company": "レスポンス文字列", "invitationCode": "レスポンス文字列", "apiKeys": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "permissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "resourcePermissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } } ``` *** ### 現在のユーザーの詳細情報の更新 PUT `/api/v1/users/current/` #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | -------------- | -------------- | --- | -- | | avatar | string (uri) | いいえ | | | name | string | はい | | | email | string (email) | はい | | | company | string | いいえ | | | invitationCode | string | いいえ | | **リクエスト構造の例** ```typescript { "avatar"?: string (uri) // 任意 "name": string "email": string (email) "company"?: string // 任意 "invitationCode"?: string // 任意 } ``` **リクエストのサンプル値** ```json { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X PUT "https://api.maiagent.ai/api/v1/users/current/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" }; axios.put("https://api.maiagent.ai/api/v1/users/current/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/users/current/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" } response = requests.put(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php put("https://api.maiagent.ai/api/v1/users/current/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "avatar": "https://example.com/file.jpg", "name": "サンプル名", "email": "user@example.com", "company": "サンプル文字列", "invitationCode": "サンプル文字列" } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "avatar"?: string (uri) // 任意 "name": string "email": string (email) "authSource": { "id": string (uuid) "name": string } "company"?: string // 任意 "invitationCode"?: string // 任意 "apiKeys": [ // 指定した組織におけるユーザーの API キー一覧を取得します。 処理の流れ: 1. request から現在の組織インスタンスを取得します 2. 組織インスタンスが存在しない場合（通常はサードパーティ SSO ログイン時に発生）、ユーザーの認証ソースを通じて その認証ソースのデフォルト組織を検索します（is_auth_source_default_organization=True） 注意: - サードパーティ SSO ログイン時、request には organization_instance が含まれません - auth_source と is_auth_source_default_organization のフラグを通じて組織を特定する必要があります object ] "permissions": object // 現在の組織におけるユーザーの権限を取得します（親子のネスト構造）。 "resourcePermissions": object // 現在の組織におけるユーザーのリソース作成権限を取得します。 } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "avatar": "https://example.com/file.jpg", "name": "レスポンス文字列", "email": "response@example.com", "authSource": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列" }, "company": "レスポンス文字列", "invitationCode": "レスポンス文字列", "apiKeys": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "permissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" }, "resourcePermissions": { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } } ``` *** ### メンバーの所属ロールの更新 POST `/api/organizations/{organizationPk}/members/{id}/update-groups/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `id` | ✅ | string | A UUID string identifying this 成員. | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------ | -------------- | -- | -- | | groups | array\[string] | はい | | **リクエスト構造の例** ```typescript { "groups": [ string (uuid) ] } ``` **リクエストのサンプル値** ```json { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] }; axios.post("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "email": string "isOwner": boolean // メンバーが組織のオーナーかどうかを確認します（OWNER Group を通じて） 同一 request 内での重複クエリを避けるためにキャッシュを使用します キャッシュの有効期間: member instance が存在する間は有効です 重複クエリを避けるため、annotation の結果があればそれを優先して使用します "permissions": [ object ] "groups": [ object ] "createdAt": string (timestamp) } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "email": "レスポンス文字列", "isOwner": false, "permissions": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "groups": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "createdAt": "レスポンス文字列" } ``` **ステータスコード: 400** **レスポンス構造の例** ```typescript object ``` *** ### メンバーの所属ロールの更新 POST `/api/v1/organizations/{organizationPk}/members/{id}/update-groups/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `id` | ✅ | string | A UUID string identifying this 成員. | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### リクエスト内容 **リクエストパラメータ** | フィールド | 型 | 必須 | 説明 | | ------ | -------------- | -- | -- | | groups | array\[string] | はい | | **リクエスト構造の例** ```typescript { "groups": [ string (uuid) ] } ``` **リクエストのサンプル値** ```json { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] } ``` #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X POST "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/" \ -H "Authorization: Api-Key YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] }' # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY', 'Content-Type': 'application/json' } }; // リクエスト内容 (payload) const data = { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] }; axios.post("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/" headers = { "Authorization": "Api-Key YOUR_API_KEY", "Content-Type": "application/json" } # リクエスト内容 (payload) data = { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] } response = requests.post(url, json=data, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php post("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/update-groups/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY', 'Content-Type' => 'application/json' ], 'json' => { "groups": [ "4e368ab4-c543-48a2-bbb8-f6f5a0bf6c61", "5f479bc5-d654-59b3-ccc9-g7g6b1cg7d72" ] } ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "id": string (uuid) "name": string "email": string "isOwner": boolean // メンバーが組織のオーナーかどうかを確認します（OWNER Group を通じて） 同一 request 内での重複クエリを避けるためにキャッシュを使用します キャッシュの有効期間: member instance が存在する間は有効です 重複クエリを避けるため、annotation の結果があればそれを優先して使用します "permissions": [ object ] "groups": [ object ] "createdAt": string (timestamp) } ``` **レスポンスのサンプル値** ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンス文字列", "email": "レスポンス文字列", "isOwner": false, "permissions": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "groups": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "レスポンスのサンプル名", "description": "レスポンスのサンプル説明" } ], "createdAt": "レスポンス文字列" } ``` **ステータスコード: 400** **レスポンス構造の例** ```typescript object ``` *** ### 指定したメンバーの削除 DELETE `/api/organizations/{organizationPk}/members/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `id` | ✅ | string | A UUID string identifying this 成員. | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X DELETE "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; // リクエスト内容 (payload) const data = null; axios.delete("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.delete(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php delete("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 | ステータスコード | 説明 | | -------- | ---------------- | | 204 | No response body | *** ### 指定したメンバーの削除 DELETE `/api/v1/organizations/{organizationPk}/members/{id}/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ---------------- | -- | ------ | ------------------------------------ | | `id` | ✅ | string | A UUID string identifying this 成員. | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X DELETE "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; // リクエスト内容 (payload) const data = null; axios.delete("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", data, config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.delete(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php delete("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 | ステータスコード | 説明 | | -------- | ---------------- | | 204 | No response body | *** ### メンバー利用統計の取得 GET `/api/organizations/{organizationPk}/usage-statistics/members/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `chatbot` | ❌ | string | 特定の AI アシスタント ID で絞り込み | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `includeTime` | ❌ | boolean | 時間でのみ集計された時系列データをトレンドグラフ用に返すかどうか（true/false）。true に設定した場合、レスポンスにはエンティティ情報は含まれず、時間フィールドと統計値のみとなり、ページネーションも行われません。 | | `page` | ❌ | integer | ページ番号 | | `pageSize` | ❌ | integer | 1 ページあたりの件数 | | `search` | ❌ | string | メンバー ID、名前、または Email で検索 | | `sortBy` | ❌ | string | ソート対象フィールド | | `sortOrder` | ❌ | string | 並び順 (asc/desc) | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "count"?: integer // 結果件数 (任意) "results"?: [ // 任意 { "member"?: { // 任意 { "id"?: string (uuid) // メンバー ID (任意) "name"?: string // メンバー名 (任意) "email"?: string // メンバーのメールアドレス (任意) } } "datetime"?: string (date-time) // タイムスタンプ（include_time=true かつ time_granularity=hour の場合にのみ出現） (任意) "period"?: string (date) // 日付（include_time=true かつ time_granularity=day/month の場合にのみ出現） (任意) "input_characters_count"?: integer // 入力文字数 (任意) "output_characters_count"?: integer // 出力文字数 (任意) "input_token_usage"?: integer // 入力 Token 数 (任意) "output_token_usage"?: integer // 出力 Token 数 (任意) "messages_count"?: integer // メッセージ数 (任意) "conversations_count"?: integer // 会話数 (任意) "total_characters_count"?: integer // 文字数の合計 (任意) "total_token_usage"?: integer // Token 数の合計 (任意) } ] } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "count": 2, "results": [ { "member": { "id": "3a245511-d5e0-4e06-9dc6-1106915b9a8a", "name": "山田太郎", "email": "wang@example.com" }, "input_characters_count": 10000, "output_characters_count": 15000, "input_token_usage": 2500, "output_token_usage": 3750, "messages_count": 100, "conversations_count": 50, "total_characters_count": 25000, "total_token_usage": 6250 } ] } ] } ``` *** ### メンバー利用統計の取得 GET `/api/v1/organizations/{organizationPk}/usage-statistics/members/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `chatbot` | ❌ | string | 特定の AI アシスタント ID で絞り込み | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `includeTime` | ❌ | boolean | 時間でのみ集計された時系列データをトレンドグラフ用に返すかどうか（true/false）。true に設定した場合、レスポンスにはエンティティ情報は含まれず、時間フィールドと統計値のみとなり、ページネーションも行われません。 | | `page` | ❌ | integer | ページ番号 | | `pageSize` | ❌ | integer | 1 ページあたりの件数 | | `search` | ❌ | string | メンバー ID、名前、または Email で検索 | | `sortBy` | ❌ | string | ソート対象フィールド | | `sortOrder` | ❌ | string | 並び順 (asc/desc) | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/?chatbot=example&endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "count"?: integer // 結果件数 (任意) "results"?: [ // 任意 { "member"?: { // 任意 { "id"?: string (uuid) // メンバー ID (任意) "name"?: string // メンバー名 (任意) "email"?: string // メンバーのメールアドレス (任意) } } "datetime"?: string (date-time) // タイムスタンプ（include_time=true かつ time_granularity=hour の場合にのみ出現） (任意) "period"?: string (date) // 日付（include_time=true かつ time_granularity=day/month の場合にのみ出現） (任意) "input_characters_count"?: integer // 入力文字数 (任意) "output_characters_count"?: integer // 出力文字数 (任意) "input_token_usage"?: integer // 入力 Token 数 (任意) "output_token_usage"?: integer // 出力 Token 数 (任意) "messages_count"?: integer // メッセージ数 (任意) "conversations_count"?: integer // 会話数 (任意) "total_characters_count"?: integer // 文字数の合計 (任意) "total_token_usage"?: integer // Token 数の合計 (任意) } ] } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "count": 2, "results": [ { "member": { "id": "3a245511-d5e0-4e06-9dc6-1106915b9a8a", "name": "山田太郎", "email": "wang@example.com" }, "input_characters_count": 10000, "output_characters_count": 15000, "input_token_usage": 2500, "output_token_usage": 3750, "messages_count": 100, "conversations_count": 50, "total_characters_count": 25000, "total_token_usage": 6250 } ] } ] } ``` *** ### メンバー利用統計サマリーの取得 GET `/api/organizations/{organizationPk}/usage-statistics/members/summary/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "total_input_characters"?: integer // 入力文字数の合計 (任意) "total_output_characters"?: integer // 出力文字数の合計 (任意) "total_characters"?: integer // 文字数の合計 (任意) "total_input_tokens"?: integer // 入力 Token 数の合計 (任意) "total_output_tokens"?: integer // 出力 Token 数の合計 (任意) "total_tokens"?: integer // Token 数の合計 (任意) "total_messages"?: integer // メッセージ数の合計 (任意) "total_conversations"?: integer // 会話数の合計 (任意) "total_members"?: integer // メンバー数の合計 (任意) } ``` **レスポンスのサンプル値** ```json { "total_input_characters": 456, "total_output_characters": 456, "total_characters": 456, "total_input_tokens": 456, "total_output_tokens": 456, "total_tokens": 456, "total_messages": 456, "total_conversations": 456, "total_members": 456 } ``` *** ### メンバー利用統計サマリーの取得 GET `/api/v1/organizations/{organizationPk}/usage-statistics/members/summary/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/members/summary/?endDate=example&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "total_input_characters"?: integer // 入力文字数の合計 (任意) "total_output_characters"?: integer // 出力文字数の合計 (任意) "total_characters"?: integer // 文字数の合計 (任意) "total_input_tokens"?: integer // 入力 Token 数の合計 (任意) "total_output_tokens"?: integer // 出力 Token 数の合計 (任意) "total_tokens"?: integer // Token 数の合計 (任意) "total_messages"?: integer // メッセージ数の合計 (任意) "total_conversations"?: integer // 会話数の合計 (任意) "total_members"?: integer // メンバー数の合計 (任意) } ``` **レスポンスのサンプル値** ```json { "total_input_characters": 456, "total_output_characters": 456, "total_characters": 456, "total_input_tokens": 456, "total_output_tokens": 456, "total_tokens": 456, "total_messages": 456, "total_conversations": 456, "total_members": 456 } ``` *** ### AI アシスタント利用統計の取得 GET `/api/organizations/{organizationPk}/usage-statistics/chatbots/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `includeTime` | ❌ | boolean | 時間でのみ集計された時系列データをトレンドグラフ用に返すかどうか（true/false）。true に設定した場合、レスポンスにはエンティティ情報は含まれず、時間フィールドと統計値のみとなり、ページネーションも行われません。 | | `page` | ❌ | integer | ページ番号 | | `pageSize` | ❌ | integer | 1 ページあたりの件数 | | `search` | ❌ | string | AI アシスタント ID または名前で検索 | | `sortBy` | ❌ | string | ソート対象フィールド | | `sortOrder` | ❌ | string | 並び順 (asc/desc) | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "count"?: integer // 結果件数 (任意) "results"?: [ // 任意 { "chatbot"?: { // 任意 { "id"?: string (uuid) // AI アシスタント ID (任意) "name"?: string // AI アシスタント名 (任意) } } "datetime"?: string (date-time) // タイムスタンプ（include_time=true かつ time_granularity=hour の場合にのみ出現） (任意) "period"?: string (date) // 日付（include_time=true かつ time_granularity=day/month の場合にのみ出現） (任意) "input_characters_count"?: integer // 入力文字数 (任意) "output_characters_count"?: integer // 出力文字数 (任意) "input_token_usage"?: integer // 入力 Token 数 (任意) "output_token_usage"?: integer // 出力 Token 数 (任意) "messages_count"?: integer // メッセージ数 (任意) "conversations_count"?: integer // 会話数 (任意) "total_characters_count"?: integer // 文字数の合計 (任意) "total_token_usage"?: integer // Token 数の合計 (任意) } ] } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "count": 2, "results": [ { "chatbot": { "id": "5b646600-f6e0-4f07-aec7-0207a26c0a9b", "name": "カスタマーサポートアシスタント" }, "input_characters_count": 10000, "output_characters_count": 15000, "input_token_usage": 2500, "output_token_usage": 3750, "messages_count": 100, "conversations_count": 50, "total_characters_count": 25000, "total_token_usage": 6250 } ] } ] } ``` *** ### AI アシスタント利用統計の取得 GET `/api/v1/organizations/{organizationPk}/usage-statistics/chatbots/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `includeTime` | ❌ | boolean | 時間でのみ集計された時系列データをトレンドグラフ用に返すかどうか（true/false）。true に設定した場合、レスポンスにはエンティティ情報は含まれず、時間フィールドと統計値のみとなり、ページネーションも行われません。 | | `page` | ❌ | integer | ページ番号 | | `pageSize` | ❌ | integer | 1 ページあたりの件数 | | `search` | ❌ | string | AI アシスタント ID または名前で検索 | | `sortBy` | ❌ | string | ソート対象フィールド | | `sortOrder` | ❌ | string | 並び順 (asc/desc) | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/?endDate=example&includeTime=true&page=1&pageSize=1&search=example&sortBy=conversations_count&sortOrder=asc&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "count": integer "next"?: string (uri) // 任意 "previous"?: string (uri) // 任意 "results": [ { "count"?: integer // 結果件数 (任意) "results"?: [ // 任意 { "chatbot"?: { // 任意 { "id"?: string (uuid) // AI アシスタント ID (任意) "name"?: string // AI アシスタント名 (任意) } } "datetime"?: string (date-time) // タイムスタンプ（include_time=true かつ time_granularity=hour の場合にのみ出現） (任意) "period"?: string (date) // 日付（include_time=true かつ time_granularity=day/month の場合にのみ出現） (任意) "input_characters_count"?: integer // 入力文字数 (任意) "output_characters_count"?: integer // 出力文字数 (任意) "input_token_usage"?: integer // 入力 Token 数 (任意) "output_token_usage"?: integer // 出力 Token 数 (任意) "messages_count"?: integer // メッセージ数 (任意) "conversations_count"?: integer // 会話数 (任意) "total_characters_count"?: integer // 文字数の合計 (任意) "total_token_usage"?: integer // Token 数の合計 (任意) } ] } ] } ``` **レスポンスのサンプル値** ```json { "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "count": 2, "results": [ { "chatbot": { "id": "5b646600-f6e0-4f07-aec7-0207a26c0a9b", "name": "カスタマーサポートアシスタント" }, "input_characters_count": 10000, "output_characters_count": 15000, "input_token_usage": 2500, "output_token_usage": 3750, "messages_count": 100, "conversations_count": 50, "total_characters_count": 25000, "total_token_usage": 6250 } ] } ] } ``` *** ### AI アシスタント利用統計サマリーの取得 GET `/api/organizations/{organizationPk}/usage-statistics/chatbots/summary/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "total_input_characters"?: integer // 入力文字数の合計 (任意) "total_output_characters"?: integer // 出力文字数の合計 (任意) "total_characters"?: integer // 文字数の合計 (任意) "total_input_tokens"?: integer // 入力 Token 数の合計 (任意) "total_output_tokens"?: integer // 出力 Token 数の合計 (任意) "total_tokens"?: integer // Token 数の合計 (任意) "total_messages"?: integer // メッセージ数の合計 (任意) "total_conversations"?: integer // 会話数の合計 (任意) "total_chatbots"?: integer // AI アシスタント数の合計 (任意) } ``` **レスポンスのサンプル値** ```json { "total_input_characters": 456, "total_output_characters": 456, "total_characters": 456, "total_input_tokens": 456, "total_output_tokens": 456, "total_tokens": 456, "total_messages": 456, "total_conversations": 456, "total_chatbots": 456 } ``` *** ### AI アシスタント利用統計サマリーの取得 GET `/api/v1/organizations/{organizationPk}/usage-statistics/chatbots/summary/` #### パラメータ | パラメータ名 | 必須 | 型 | 説明 | | ----------------- | -- | ------ | ------------------------------------ | | `organizationPk` | ✅ | string | A UUID string identifying this 組織 ID | | `endDate` | ❌ | string | 終了日。フォーマット: YYYY-MM-DD | | `startDate` | ✅ | string | 開始日。フォーマット: YYYY-MM-DD | | `timeGranularity` | ❌ | string | 時間粒度 (hour/day/month) | #### コード例 {% tabs %} {% tab title="Shell/Bash" %} ```bash # API 呼び出しの例 (Shell) curl -X GET "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day" \ -H "Authorization: Api-Key YOUR_API_KEY" # 実行する前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。 ``` {% endtab %} {% tab title="JavaScript" %} ```javascript const axios = require('axios'); // リクエストヘッダーを設定 const config = { headers: { 'Authorization': 'Api-Key YOUR_API_KEY' } }; axios.get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day", config) .then(response => { console.log('レスポンスの取得に成功しました:'); console.log(response.data); }) .catch(error => { console.error('リクエストでエラーが発生しました:'); console.error(error.response?.data || error.message); }); ``` {% endtab %} {% tab title="Python" %} ```python import requests url = "https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day" headers = { "Authorization": "Api-Key YOUR_API_KEY" } response = requests.get(url, headers=headers) try: print("レスポンスの取得に成功しました:") print(response.json()) except Exception as e: print("リクエストでエラーが発生しました:", e) ``` {% endtab %} {% tab title="PHP" %} ```php get("https://api.maiagent.ai/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/usage-statistics/chatbots/summary/?endDate=example&startDate=example&timeGranularity=day", [ 'headers' => [ 'Authorization' => 'Api-Key YOUR_API_KEY' ] ]); $data = json_decode($response->getBody(), true); echo "レスポンスの取得に成功しました:\n"; print_r($data); } catch (Exception $e) { echo 'リクエストでエラーが発生しました: ' . $e->getMessage(); } ?> ``` {% endtab %} {% endtabs %} #### レスポンス内容 **ステータスコード: 200** **レスポンス構造の例** ```typescript { "total_input_characters"?: integer // 入力文字数の合計 (任意) "total_output_characters"?: integer // 出力文字数の合計 (任意) "total_characters"?: integer // 文字数の合計 (任意) "total_input_tokens"?: integer // 入力 Token 数の合計 (任意) "total_output_tokens"?: integer // 出力 Token 数の合計 (任意) "total_tokens"?: integer // Token 数の合計 (任意) "total_messages"?: integer // メッセージ数の合計 (任意) "total_conversations"?: integer // 会話数の合計 (任意) "total_chatbots"?: integer // AI アシスタント数の合計 (任意) } ``` **レスポンスのサンプル値** ```json { "total_input_characters": 456, "total_output_characters": 456, "total_characters": 456, "total_input_tokens": 456, "total_output_tokens": 456, "total_tokens": 456, "total_messages": 456, "total_conversations": 456, "total_chatbots": 456 } ``` *** --- # 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 current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.maiagent.ai/api/api-doc-ja/api-reference/zu-zhi-he-cheng-yuan.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.