Source: https://ailoot.ai/docs/ja/cabinet/auth/
Canonical: https://ailoot.ai/docs/ja/cabinet/auth/
Language: ja

[ダッシュボードAPI](https://ailoot.ai/docs/ja/) 

# ログインとセッション

[Markdown](https://ailoot.ai/docs/ja/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` | ログアウトとrefresh tokenの失効 | ログイン不要。追加条件は各メソッドに記載 |
| `GET /api/v1/auth/me` | 現在のユーザー、残高、制限値 | ダッシュボードのトークン |
| `POST /api/v1/auth/passkey/login/begin` | passkeyログインの開始 | ログイン不要。追加条件は各メソッドに記載 |
| `POST /api/v1/auth/passkey/login/finish` | passkeyログインの完了 | ログイン不要。追加条件は各メソッドに記載 |
| `POST /api/v1/auth/refresh` | トークンの更新 | ログイン不要。追加条件は各メソッドに記載 |
| `POST /api/v1/auth/register` | 新規登録 | ログイン不要。追加条件は各メソッドに記載 |
| `POST /api/v1/auth/reset-password` | パスワードの再設定 | ログイン不要。追加条件は各メソッドに記載 |
| `POST /api/v1/auth/revoke-all-sessions` | すべてのセッションの失効 | ダッシュボードのトークン |
| `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** — パスワード再設定のリクエスト

アクセス：ログイン不要。追加条件は各メソッドに記載

頻度制限：同じアドレスから5リクエスト／60秒。

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** — メールアドレスとパスワードでログイン

アクセス：ログイン不要。追加条件は各メソッドに記載

機能の利用可否と追加のアクセス条件は、リクエスト実行時に確認されます。

頻度制限：同じアドレスから20リクエスト／60秒。

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を使ったログインの完了

アクセス：ログイン不要。追加条件は各メソッドに記載

機能の利用可否と追加のアクセス条件は、リクエスト実行時に確認されます。

頻度制限：同じアドレスから20リクエスト／60秒。

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** — ログアウトとrefresh tokenの失効

アクセス：ログイン不要。追加条件は各メソッドに記載

POST`/api/v1/auth/logout`

## JSON／フォームのフィールド

| フィールド | タイプ | 必須 | 検証／説明 |
| --- | --- | --- | --- |
| `refresh_token` | `string` | いいえ | ；任意：指定した更新トークンを失効 |

リクエストボディのテンプレート

```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** — 現在のユーザー、残高、制限値

アクセス：ダッシュボードのトークン

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** — passkeyログインの開始

アクセス：ログイン不要。追加条件は各メソッドに記載

機能の利用可否と追加のアクセス条件は、リクエスト実行時に確認されます。

頻度制限：同じアドレスから20リクエスト／60秒。

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 bodyは\<=65536バイト。登録と削除にはパスワードが必要です。

このメソッドはデータを変更します。再送が安全なのは、Idempotency-Keyが明示されているメソッドのみです。レスポンスが失われた場合は、先に結果（例：キーの一覧）を確認してから、再送するかを判断してください。

**POST /api/v1/auth/passkey/login/finish** — passkeyログインの完了

アクセス：ログイン不要。追加条件は各メソッドに記載

機能の利用可否と追加のアクセス条件は、リクエスト実行時に確認されます。

頻度制限：同じアドレスから20リクエスト／60秒。

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 bodyは\<=65536バイト。登録と削除にはパスワードが必要です。

このメソッドはデータを変更します。再送が安全なのは、Idempotency-Keyが明示されているメソッドのみです。レスポンスが失われた場合は、先に結果（例：キーの一覧）を確認してから、再送するかを判断してください。

**POST /api/v1/auth/refresh** — トークンの更新

アクセス：ログイン不要。追加条件は各メソッドに記載

機能の利用可否と追加のアクセス条件は、リクエスト実行時に確認されます。

頻度制限：同じアドレスから30リクエスト／60秒。

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** — 新規登録

アクセス：ログイン不要。追加条件は各メソッドに記載

頻度制限：同じアドレスから5リクエスト／60秒。

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** — パスワードの再設定

アクセス：ログイン不要。追加条件は各メソッドに記載

頻度制限：同じアドレスから10リクエスト／60秒。

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** — すべてのセッションの失効

アクセス：ダッシュボードのトークン

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** — 確認コードの送信

アクセス：ログイン不要。追加条件は各メソッドに記載

頻度制限：同じアドレスから5リクエスト／60秒。

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** — 招待の検証

アクセス：ログイン不要。追加条件は各メソッドに記載

機能の利用可否と追加のアクセス条件は、リクエスト実行時に確認されます。

頻度制限：同じアドレスから10リクエスト／60秒。

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)"
  }
}
```

補足：このメソッドは招待を確認し、コードは消費しません。例はメソッドの仕様を説明するもので、実行されません。

このメソッドは招待コードを確認するだけで、コードを消費しません。リクエストの頻度制限を守れば、確認を繰り返せます。結果はリクエスト時点のコードの状態を示します。

**POST /api/v1/auth/validate-promo-code** — プロモーションコードの検証

アクセス：ログイン不要。追加条件は各メソッドに記載

機能の利用可否と追加のアクセス条件は、リクエスト実行時に確認されます。

頻度制限：同じアドレスから10リクエスト／60秒。

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)"
  }
}
```

補足：このメソッドはプロモーションコードを確認し、ボーナスは付与しません。例はメソッドの仕様を説明するもので、実行されません。

このメソッドはプロモーションコードを確認するだけで、アカウントには適用しません。リクエストの頻度制限を守れば、確認を繰り返せます。結果はリクエスト時点のコードの状態を示します。

## ログインとセッション · 2FA

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

- `data.requires_2fa === true` → [TotpLoginResponse](https://ailoot.ai/docs/ja/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/ja/cabinet/schemas-1/#authresponse) → `Authorization: Bearer $TOKEN`

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

ご不明な点はありますか？Request IDと状況の説明をお送りください。調査をお手伝いします。[サポートに問い合わせる](mailto:support@ailoot.ai)

## Ailoot · 企業とそのプロジェクト群





Ailootは、蓄積した運営経験、幅広い顧客基盤、安定したサービス、継続的なKPI管理を基盤としています。





企業とそのプロジェクト群：数百万の顧客、毎月数十億規模の売上。





Ailootはこの運営経験を、お客様の製品、エージェント、アプリケーション、自動化でAI機能を利用するためのAPIアクセスに活かしています。