dokumentácia
API používateľského účtu

Profil a zabezpečenie

Markdown

Metódy, polia požiadaviek a odpovede.

Úplný sprievodca

Sekcia obsahuje 6 metód. Otvorte metódu a pozrite si podmienky prístupu, polia požiadavky a odpoveď.

Metóda a cestaOpisPrístup
PUT /api/v1/userÚprava profiluToken používateľského účtu
GET /api/v1/user/passkeysZoznam passkeyToken používateľského účtu
PUT /api/v1/user/passwordZmena heslaToken používateľského účtu
GET /api/v1/user/profileProfil, zostatok a prepojeniaToken používateľského účtu
GET /api/v1/user/totp/statusStav 2FA (TOTP)Token používateľského účtu
GET /api/v1/user/totp/verification-methodSpôsob overovania TOTPToken používateľského účtu
PUT /api/v1/user – Úprava profilu

Prístup: token používateľského účtu

PUT/api/v1/user

Polia JSON / formulára

PoleTypPovinnéKontrola / opis
usernamestringnie; môže byť null
avatar_urlstringnie; môže byť null
balance_notify_enabledbooleannie; môže byť null
balance_notify_thresholdnumbernie; môže byť null
Šablóna tela požiadavky
{
  "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 označuje váš vstup a jeho typ. Nahraďte hodnoty a ponechajte iba potrebné voliteľné polia; reťazcové zástupné hodnoty sa neodosielajú namiesto čísel, hodnôt boolean, objektov alebo polí.

Schéma požiadavky: UpdateProfileRequest

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Dátové schémy odpovede: User, UserProfileResponse. Polia a typy nájdete na stránkach „Dátové schémy“.

Schéma odpovede, ilustračné hodnoty
{
  "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)"
  }
}

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Osobitosti: operácia mení stav alebo pokračuje v jednorazovej autorizácii; príklad opisuje kontrakt a nevykonáva sa.

Osobitosti: limity výdavkov kľúčov (quota, quota_used) sa vracajú v odpovedi pre kľúče, nie v profile. frozen_balance je rezervovaná suma, nemožno ju považovať za voľný zostatok.

GET /api/v1/user/passkeys – Zoznam passkey

Prístup: token používateľského účtu

GET/api/v1/user/passkeys
Čítanie; ID sa preberá z vašej predchádzajúcej odpovede
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

Telo požiadavky sa nevyžaduje. Vyššie uvedené parametre odovzdajte v URL.

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Dátové schémy odpovede: PasskeyCredentialSummary. Polia a typy nájdete na stránkach „Dátové schémy“.

Schéma odpovede, ilustračné hodnoty
{
  "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)"
  }
}

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Osobitosti: credential pochádza z navigator.credentials; session_token z begin. Finish body <=65536 bajtov; registrácia a odstránenie vyžadujú heslo.

PUT /api/v1/user/password – Zmena hesla

Prístup: token používateľského účtu

PUT/api/v1/user/password

Polia JSON / formulára

PoleTypPovinnéKontrola / opis
old_passwordstringánorequired
new_passwordstringánorequired,min=6
Šablóna tela požiadavky
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER označuje váš vstup a jeho typ. Nahraďte hodnoty a ponechajte iba potrebné voliteľné polia; reťazcové zástupné hodnoty sa neodosielajú namiesto čísel, hodnôt boolean, objektov alebo polí.

Schéma požiadavky: ChangePasswordRequest

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Schéma odpovede, ilustračné hodnoty
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Osobitosti: operácia mení stav alebo pokračuje v jednorazovej autorizácii; príklad opisuje kontrakt a nevykonáva sa.

GET /api/v1/user/profile – Profil, zostatok a prepojenia

Prístup: token používateľského účtu

GET/api/v1/user/profile
Čítanie; ID sa preberá z vašej predchádzajúcej odpovede
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Telo požiadavky sa nevyžaduje. Vyššie uvedené parametre odovzdajte v URL.

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Dátové schémy odpovede: User, UserProfileResponse. Polia a typy nájdete na stránkach „Dátové schémy“.

Schéma odpovede, ilustračné hodnoty
{
  "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)"
  }
}

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Osobitosti: limity výdavkov kľúčov (quota, quota_used) sa vracajú v odpovedi pre kľúče, nie v profile. frozen_balance je rezervovaná suma, nemožno ju považovať za voľný zostatok.

GET /api/v1/user/totp/status – Stav 2FA (TOTP)

Prístup: token používateľského účtu

GET/api/v1/user/totp/status
Čítanie; ID sa preberá z vašej predchádzajúcej odpovede
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

Telo požiadavky sa nevyžaduje. Vyššie uvedené parametre odovzdajte v URL.

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Dátové schémy odpovede: TotpStatusResponse. Polia a typy nájdete na stránkach „Dátové schémy“.

Schéma odpovede, ilustračné hodnoty
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Osobitosti: secret a setup_token sú tajné; overovanie závisí od nastavení TOTP a používateľa.

GET /api/v1/user/totp/verification-method – Spôsob overovania TOTP

Prístup: token používateľského účtu

GET/api/v1/user/totp/verification-method
Čítanie; ID sa preberá z vašej predchádzajúcej odpovede
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

Telo požiadavky sa nevyžaduje. Vyššie uvedené parametre odovzdajte v URL.

Odpoveď

Odpoveď JSON obsahuje code, message a data. Obsah data je opísaný v schémach nižšie.

Schéma odpovede, ilustračné hodnoty
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

Osobitosti: všetky osobné údaje a objekty sú obmedzené na subjekt JWT.

Osobitosti: secret a setup_token sú tajné; overovanie závisí od nastavení TOTP a používateľa.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
Máte ďalšie otázky? Pošlite Request ID a opis problému – pomôžeme vám ho vyriešiť.Napísať podpore