Профиль и безопасность

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

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

В разделе 6 методов. Откройте метод, чтобы посмотреть условия доступа, поля запроса и ответ.

Метод и путь	Описание	Доступ
`PUT /api/v1/user`	Изменение профиля	Токен кабинета
`GET /api/v1/user/passkeys`	Список passkey	Токен кабинета
`PUT /api/v1/user/password`	Изменение пароля	Токен кабинета
`GET /api/v1/user/profile`	Профиль, баланс и привязки	Токен кабинета
`GET /api/v1/user/totp/status`	Состояние 2FA (TOTP)	Токен кабинета
`GET /api/v1/user/totp/verification-method`	Способ проверки TOTP	Токен кабинета

PUT /api/v1/user — Изменение профиля

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

PUT/api/v1/user

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`username`	`string`	нет	; может быть null
`avatar_url`	`string`	нет	; может быть null
`balance_notify_enabled`	`boolean`	нет	; может быть null
`balance_notify_threshold`	`number`	нет	; может быть 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 — Список passkey

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

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 body <=65536 байт; регистрация и удаление требуют пароля.

PUT /api/v1/user/password — Изменение пароля

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

PUT/api/v1/user/password

Поля JSON / формы

Поле	Тип	Обязательно	Проверка / описание
`old_password`	`string`	да	required
`new_password`	`string`	да	required,min=6

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

{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

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

Ответ

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

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

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

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

GET /api/v1/user/profile — Профиль, баланс и привязки

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

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.

GET /api/v1/user/totp/status — Состояние 2FA (TOTP)

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

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

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

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 и описание — поможем разобраться.Написать в поддержку