文件
控制台
控制台 API

個人資料與安全性

Markdown

方法、請求欄位與回應。

完整指南

本區共有 6 個方法。開啟方法即可查看存取條件、請求欄位與回應。

方法與路徑說明存取條件
PUT /api/v1/user修改使用者資料控制台 token
GET /api/v1/user/passkeys通行金鑰清單控制台 token
PUT /api/v1/user/password變更密碼控制台 token
GET /api/v1/user/profile使用者資料、餘額與綁定資訊控制台 token
GET /api/v1/user/totp/status2FA (TOTP) 狀態控制台 token
GET /api/v1/user/totp/verification-methodTOTP 驗證方式控制台 token
PUT /api/v1/user —修改使用者資料

存取條件：控制台 token

PUT/api/v1/user

JSON／表單欄位

欄位類型必填驗證／說明
usernamestring否; 可為 null
avatar_urlstring否; 可為 null
balance_notify_enabledboolean否; 可為 null
balance_notify_thresholdnumber否; 可為 null
請求主體範本
{
  "username": "PLACEHOLDER_USERNAME (string)",
  "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
  "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
  "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)"
}

PLACEHOLDER 表示您的輸入及其型別。請替換值，並只保留需要的選填欄位；不要將字串標記當成數字、boolean、物件或陣列傳送。

請求結構描述：UpdateProfileRequest

回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應資料的結構描述：User，UserProfileResponse。欄位與型別請見「資料結構描述」頁面。

回應結構描述，欄位值僅為示例
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

注意事項：此操作會變更狀態，或繼續一次性授權流程；範例僅說明介面契約，不會執行。

注意事項：金鑰的支出限制 (quota、quota_used) 會出現在金鑰的回應中，而非使用者資料中。frozen_balance 是已保留的金額，不能視為可用餘額。

GET /api/v1/user/passkeys —通行金鑰清單

存取條件：控制台 token

GET/api/v1/user/passkeys
讀取；ID 取自您先前的回應
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

不需要請求主體。請在 URL 中傳入上述參數。

回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應資料的結構描述：PasskeyCredentialSummary。欄位與型別請見「資料結構描述」頁面。

回應結構描述，欄位值僅為示例
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "name": "PLACEHOLDER_NAME (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "backup": "PLACEHOLDER_BACKUP (boolean)"
  }
}

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

注意事項：credential 取自 navigator.credentials；session_token 取自 begin。Finish 的請求主體 <=65536 位元組；註冊與刪除需要密碼。

PUT /api/v1/user/password —變更密碼

存取條件：控制台 token

PUT/api/v1/user/password

JSON／表單欄位

欄位類型必填驗證／說明
old_passwordstring是required
new_passwordstring是required,min=6
請求主體範本
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER 表示您的輸入及其型別。請替換值，並只保留需要的選填欄位；不要將字串標記當成數字、boolean、物件或陣列傳送。

請求結構描述：ChangePasswordRequest

回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應結構描述，欄位值僅為示例
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

注意事項：此操作會變更狀態，或繼續一次性授權流程；範例僅說明介面契約，不會執行。

GET /api/v1/user/profile —使用者資料、餘額與綁定資訊

存取條件：控制台 token

GET/api/v1/user/profile
讀取；ID 取自您先前的回應
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

不需要請求主體。請在 URL 中傳入上述參數。

回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應資料的結構描述：User，UserProfileResponse。欄位與型別請見「資料結構描述」頁面。

回應結構描述，欄位值僅為示例
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

注意事項：金鑰的支出限制 (quota、quota_used) 會出現在金鑰的回應中，而非使用者資料中。frozen_balance 是已保留的金額，不能視為可用餘額。

GET /api/v1/user/totp/status —2FA (TOTP) 狀態

存取條件：控制台 token

GET/api/v1/user/totp/status
讀取；ID 取自您先前的回應
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

不需要請求主體。請在 URL 中傳入上述參數。

回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應資料的結構描述：TotpStatusResponse。欄位與型別請見「資料結構描述」頁面。

回應結構描述，欄位值僅為示例
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

注意事項：secret與setup_token 是機密值；驗證方式取決於 TOTP與使用者設定。

GET /api/v1/user/totp/verification-method —TOTP 驗證方式

存取條件：控制台 token

GET/api/v1/user/totp/verification-method
讀取；ID 取自您先前的回應
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

不需要請求主體。請在 URL 中傳入上述參數。

回應

JSON 回應包含 code、message與data。data 的內容請見下方結構描述。

回應結構描述，欄位值僅為示例
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

注意事項：所有個人資料與物件，皆限於 JWT 主體的範圍。

注意事項：secret與setup_token 是機密值；驗證方式取決於 TOTP與使用者設定。

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
還有疑問嗎？請提供 Request ID與問題描述，我們會協助釐清。聯絡支援
登入註冊控制台
方案