Source: https://ailoot.ai/docs/zh-hant-tw/cabinet/auth/
Canonical: https://ailoot.ai/docs/zh-hant-tw/cabinet/auth/
Language: zh-hant-tw

[控制台 API](https://ailoot.ai/docs/zh-hant-tw/) 

# 登入與工作階段

[Markdown](https://ailoot.ai/docs/zh-hant-tw/cabinet/auth/index.md)

方法、請求欄位與回應。

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

| 方法與路徑 | 說明 | 存取條件 |
| --- | --- | --- |
| `POST /api/v1/auth/forgot-password` | 請求重設密碼 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/login` | 使用電子郵件與密碼登入 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/login/2fa` | 以 TOTP 完成登入 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/logout` | 登出並撤銷更新 token | 無須登入；其他條件請見各方法說明 |
| `GET /api/v1/auth/me` | 目前的使用者、餘額與限制 | 控制台 token |
| `POST /api/v1/auth/passkey/login/begin` | 開始以通行金鑰登入 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/passkey/login/finish` | 完成通行金鑰登入 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/refresh` | 更新 token | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/register` | 註冊 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/reset-password` | 重設密碼 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/revoke-all-sessions` | 撤銷所有工作階段 | 控制台 token |
| `POST /api/v1/auth/send-verify-code` | 傳送驗證碼 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/validate-invitation-code` | 驗證邀請碼 | 無須登入；其他條件請見各方法說明 |
| `POST /api/v1/auth/validate-promo-code` | 驗證優惠碼 | 無須登入；其他條件請見各方法說明 |

**POST /api/v1/auth/forgot-password** —請求重設密碼

存取條件：無須登入；其他條件請見各方法說明

頻率限制：同一位址每 60 秒最多 5 次請求。

POST`/api/v1/auth/forgot-password`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `email` | `string` | 是 | required,email |
| `turnstile_token` | `string` | 否 |  |

請求主體範本

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

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

請求結構描述：`ForgotPasswordRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/login** —使用電子郵件與密碼登入

存取條件：無須登入；其他條件請見各方法說明

執行請求時，會檢查功能是否可用，以及其他存取條件。

頻率限制：同一位址每 60 秒最多 20 次請求。

POST`/api/v1/auth/login`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `email` | `string` | 是 | required,email |
| `password` | `string` | 是 | required |
| `turnstile_token` | `string` | 否 |  |

請求主體範本

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

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

請求結構描述：`LoginRequest`

## 回應

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

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

若有多種可能的回應，其欄位會分別列於不同的結構描述中，不應合併成單一物件。

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/login/2fa** —以 TOTP 完成登入

存取條件：無須登入；其他條件請見各方法說明

執行請求時，會檢查功能是否可用，以及其他存取條件。

頻率限制：同一位址每 60 秒最多 20 次請求。

POST`/api/v1/auth/login/2fa`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `temp_token` | `string` | 是 | required |
| `totp_code` | `string` | 是 | required,len=6 |

請求主體範本

```json
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}
```

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

請求結構描述：`Login2FARequest`

## 回應

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

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

若有多種可能的回應，其欄位會分別列於不同的結構描述中，不應合併成單一物件。

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/logout** —登出並撤銷更新 token

存取條件：無須登入；其他條件請見各方法說明

POST`/api/v1/auth/logout`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `refresh_token` | `string` | 否 | ; 選填：撤銷指定的更新 token |

請求主體範本

```json
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}
```

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

請求結構描述：`LogoutRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**GET /api/v1/auth/me** —目前的使用者、餘額與限制

存取條件：控制台 token

GET`/api/v1/auth/me`

讀取；ID 取自您先前的回應

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -H "Authorization: Bearer $TOKEN"
```

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

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "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 是已保留的金額，不能視為可用餘額。

**POST /api/v1/auth/passkey/login/begin** —開始以通行金鑰登入

存取條件：無須登入；其他條件請見各方法說明

執行請求時，會檢查功能是否可用，以及其他存取條件。

頻率限制：同一位址每 60 秒最多 20 次請求。

POST`/api/v1/auth/passkey/login/begin`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `turnstile_token` | `string` | 否 |  |

請求主體範本

```json
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

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

請求結構描述：`PasskeyBeginLoginRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}
```

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

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/passkey/login/finish** —完成通行金鑰登入

存取條件：無須登入；其他條件請見各方法說明

執行請求時，會檢查功能是否可用，以及其他存取條件。

頻率限制：同一位址每 60 秒最多 20 次請求。

POST`/api/v1/auth/passkey/login/finish`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `session_token` | `string` | 是 | required |
| `name` | `string` | 否 |  |
| `credential` | `object` | 是 | required |

請求主體範本

```json
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}
```

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

請求結構描述：`PasskeyFinishRequest`

## 回應

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

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

若有多種可能的回應，其欄位會分別列於不同的結構描述中，不應合併成單一物件。

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

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/refresh** —更新 token

存取條件：無須登入；其他條件請見各方法說明

執行請求時，會檢查功能是否可用，以及其他存取條件。

頻率限制：同一位址每 60 秒最多 30 次請求。

POST`/api/v1/auth/refresh`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `refresh_token` | `string` | 是 | required |

請求主體範本

```json
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}
```

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

請求結構描述：`RefreshTokenRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "access_token": "PLACEHOLDER_ACCESS_TOKEN (string)",
    "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)",
    "expires_in": "PLACEHOLDER_EXPIRES_IN (integer)",
    "token_type": "PLACEHOLDER_TOKEN_TYPE (string)"
  }
}
```

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/register** —註冊

存取條件：無須登入；其他條件請見各方法說明

頻率限制：同一位址每 60 秒最多 5 次請求。

POST`/api/v1/auth/register`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `email` | `string` | 是 | required,email |
| `password` | `string` | 是 | required,min=6 |
| `verify_code` | `string` | 否 |  |
| `turnstile_token` | `string` | 否 |  |
| `promo_code` | `string` | 否 | ; 註冊優惠碼 |
| `invitation_code` | `string` | 否 | ; 邀請碼 |

請求主體範本

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "verify_code": "PLACEHOLDER_VERIFY_CODE (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)",
  "promo_code": "PLACEHOLDER_PROMO_CODE (string)",
  "invitation_code": "PLACEHOLDER_INVITATION_CODE (string)"
}
```

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

請求結構描述：`RegisterRequest`

## 回應

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

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

若有多種可能的回應，其欄位會分別列於不同的結構描述中，不應合併成單一物件。

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/reset-password** —重設密碼

存取條件：無須登入；其他條件請見各方法說明

頻率限制：同一位址每 60 秒最多 10 次請求。

POST`/api/v1/auth/reset-password`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `email` | `string` | 是 | required,email |
| `token` | `string` | 是 | required |
| `new_password` | `string` | 是 | required,min=6 |

請求主體範本

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}
```

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

請求結構描述：`ResetPasswordRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/revoke-all-sessions** —撤銷所有工作階段

存取條件：控制台 token

POST`/api/v1/auth/revoke-all-sessions`

不需要請求主體。

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

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

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/send-verify-code** —傳送驗證碼

存取條件：無須登入；其他條件請見各方法說明

頻率限制：同一位址每 60 秒最多 5 次請求。

POST`/api/v1/auth/send-verify-code`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `email` | `string` | 是 | required,email |
| `turnstile_token` | `string` | 否 |  |

請求主體範本

```json
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}
```

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

請求結構描述：`SendVerifyCodeRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}
```

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

此方法會變更資料。只有在方法標示 Idempotency-Key 時，重新傳送才是安全的。若回應遺失，請先確認操作結果 (例如金鑰清單)，再決定是否重新傳送請求。

**POST /api/v1/auth/validate-invitation-code** —驗證邀請碼

存取條件：無須登入；其他條件請見各方法說明

執行請求時，會檢查功能是否可用，以及其他存取條件。

頻率限制：同一位址每 60 秒最多 10 次請求。

POST`/api/v1/auth/validate-invitation-code`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `code` | `string` | 是 | required |

請求主體範本

```json
{
  "code": "PLACEHOLDER_CODE (string)"
}
```

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

請求結構描述：`ValidateInvitationCodeRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}
```

特性：此方法會檢查邀請，但不會耗用代碼；範例僅描述 API 契約，不會執行。

此方法僅檢查邀請碼，不會耗用該代碼。在請求頻率限制內可重複檢查；結果反映代碼在請求當下的狀態。

**POST /api/v1/auth/validate-promo-code** —驗證優惠碼

存取條件：無須登入；其他條件請見各方法說明

執行請求時，會檢查功能是否可用，以及其他存取條件。

頻率限制：同一位址每 60 秒最多 10 次請求。

POST`/api/v1/auth/validate-promo-code`

## JSON／表單欄位

| 欄位 | 類型 | 必填 | 驗證／說明 |
| --- | --- | --- | --- |
| `code` | `string` | 是 | required |

請求主體範本

```json
{
  "code": "PLACEHOLDER_CODE (string)"
}
```

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

請求結構描述：`ValidatePromoCodeRequest`

## 回應

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

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

回應結構描述，欄位值僅為示例

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "bonus_amount": "PLACEHOLDER_BONUS_AMOUNT (number)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)",
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}
```

特性：此方法會檢查優惠碼，但不會發放獎勵；範例僅描述 API 契約，不會執行。

此方法僅檢查優惠碼，不會將其套用至帳戶。在請求頻率限制內可重複檢查；結果反映代碼在請求當下的狀態。

## 登入與工作階段 · 2FA

`POST /api/v1/auth/login` → `data`

- `data.requires_2fa === true` → [TotpLoginResponse](https://ailoot.ai/docs/zh-hant-tw/cabinet/schemas-1/#totploginresponse) → `data.temp_token` → `POST /api/v1/auth/login/2fa` · `{"temp_token": "…", "totp_code": "…"}` → `data.access_token`
- `data.access_token` → [AuthResponse](https://ailoot.ai/docs/zh-hant-tw/cabinet/schemas-1/#authresponse) → `Authorization: Bearer $TOKEN`

`totp_code`: `string`, `len = 6`. `temp_token ≠ access_token`. [User](https://ailoot.ai/docs/zh-hant-tw/cabinet/schemas-1/#user)

還有疑問嗎？請提供 Request ID與問題描述，我們會協助釐清。[聯絡支援](mailto:support@ailoot.ai)

## Ailoot · 公司及其專案組合





Ailoot以累積的營運經驗、廣大的客戶群、穩定的服務及持續的KPI管理為基礎。





公司及其專案組合：數百萬客戶，每月銷售額達數十億。





Ailoot將這些營運經驗用於API存取，讓客戶的產品、代理、應用程式及自動化流程使用AI功能。