Вход и сеансы

Методы, поля запросов и ответы.

Полное руководство

В разделе 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`	нет

Шаблон тела запроса

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

PLACEHOLDER обозначает ваш ввод и его тип. Замените значения и оставьте только нужные необязательные поля; строковые маркеры не отправляются вместо чисел, boolean, объектов или массивов.

Схема запроса: ForgotPasswordRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: ForgotPasswordResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

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

Особенности: Операция изменяет состояние или продолжает одноразовую авторизацию; пример описывает контракт и не выполняется.

POST /api/v1/auth/login — Вход по электронной почте и паролю

Доступ: Без входа; дополнительные условия указаны у метода

Доступность функции и дополнительные условия доступа проверяются при выполнении запроса.

Лимит частоты: 20 запросов за 60 секунд с одного адреса.

POST/api/v1/auth/login

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`email`	`string`	да	required,email
`password`	`string`	да	required
`turnstile_token`	`string`	нет

Шаблон тела запроса

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

Схема запроса: LoginRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: TotpLoginResponse, User, AuthResponse. Поля и типы — на страницах «Схемы данных».

Если возможны несколько вариантов ответа, их поля перечислены в отдельных схемах; их не следует объединять в один объект.

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

Шаблон тела запроса

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

Схема запроса: Login2FARequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: User, AuthResponse. Поля и типы — на страницах «Схемы данных».

POST /api/v1/auth/logout — Выход и отзыв refresh token

Доступ: Без входа; дополнительные условия указаны у метода

POST/api/v1/auth/logout

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`refresh_token`	`string`	нет	; Необязательно: отозвать указанный токен обновления

Шаблон тела запроса

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

Схема запроса: LogoutRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: LogoutResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

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

GET /api/v1/auth/me — Текущий пользователь, баланс и лимиты

Доступ: Токен кабинета

GET/api/v1/auth/me

Чтение; ID берётся из вашего предыдущего ответа

curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -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 — зарезервированная сумма, её нельзя считать свободным балансом.

POST /api/v1/auth/passkey/login/begin — Начало входа с passkey

Доступ: Без входа; дополнительные условия указаны у метода

Доступность функции и дополнительные условия доступа проверяются при выполнении запроса.

Лимит частоты: 20 запросов за 60 секунд с одного адреса.

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

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`turnstile_token`	`string`	нет

Шаблон тела запроса

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

Схема запроса: PasskeyBeginLoginRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: PasskeyOptionsResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

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

Особенности: credential получен из navigator.credentials; session_token из begin. Finish body <=65536 байт; регистрация и удаление требуют пароля.

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

Шаблон тела запроса

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

Схема запроса: PasskeyFinishRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: User, AuthResponse. Поля и типы — на страницах «Схемы данных».

POST /api/v1/auth/refresh — Обновление токенов

Доступ: Без входа; дополнительные условия указаны у метода

Доступность функции и дополнительные условия доступа проверяются при выполнении запроса.

Лимит частоты: 30 запросов за 60 секунд с одного адреса.

POST/api/v1/auth/refresh

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`refresh_token`	`string`	да	required

Шаблон тела запроса

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

Схема запроса: RefreshTokenRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: RefreshTokenResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

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

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`	нет	; Код приглашения

Шаблон тела запроса

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

Схема запроса: RegisterRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: User, AuthResponse. Поля и типы — на страницах «Схемы данных».

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

Шаблон тела запроса

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

Схема запроса: ResetPasswordRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: ResetPasswordResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

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

POST /api/v1/auth/revoke-all-sessions — Отзыв всех сессий

Доступ: Токен кабинета

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

Тело запроса не требуется.

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: RevokeAllSessionsResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

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

Особенности: Все личные данные и объекты ограничены субъектом JWT.

POST /api/v1/auth/send-verify-code — Отправка кода подтверждения

Доступ: Без входа; дополнительные условия указаны у метода

Лимит частоты: 5 запросов за 60 секунд с одного адреса.

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

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`email`	`string`	да	required,email
`turnstile_token`	`string`	нет

Шаблон тела запроса

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

Схема запроса: SendVerifyCodeRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: SendVerifyCodeResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

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

POST /api/v1/auth/validate-invitation-code — Проверка приглашения

Доступ: Без входа; дополнительные условия указаны у метода

Доступность функции и дополнительные условия доступа проверяются при выполнении запроса.

Лимит частоты: 10 запросов за 60 секунд с одного адреса.

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

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`code`	`string`	да	required

Шаблон тела запроса

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

Схема запроса: ValidateInvitationCodeRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: ValidateInvitationCodeResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

{
  "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

Шаблон тела запроса

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

Схема запроса: ValidatePromoCodeRequest

Ответ

JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.

Схемы данных ответа: ValidatePromoCodeResponse. Поля и типы — на страницах «Схемы данных».

Схема ответа, значения условные

{
  "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 → data.temp_token → POST /api/v1/auth/login/2fa · {"temp_token": "…", "totp_code": "…"} → data.access_token
data.access_token → AuthResponse → Authorization: Bearer $TOKEN

totp_code: string, len = 6. temp_token ≠ access_token. User

Остались вопросы? Пришлите Request ID и описание — поможем разобраться.Написать в поддержку