dokumentace
API uživatelského panelu

Profil a zabezpečení

Markdown

Metody, pole požadavků a odpovědi.

Úplný průvodce

V této sekci je 6 metod. Otevřete metodu a prohlédněte si podmínky přístupu, pole požadavku a odpověď.

Metoda a cestaPopisPřístup
PUT /api/v1/userÚprava profiluToken uživatelského panelu
GET /api/v1/user/passkeysSeznam přístupových klíčů (passkey)Token uživatelského panelu
PUT /api/v1/user/passwordZměna heslaToken uživatelského panelu
GET /api/v1/user/profileProfil, zůstatek a propojeníToken uživatelského panelu
GET /api/v1/user/totp/statusStav 2FA (TOTP)Token uživatelského panelu
GET /api/v1/user/totp/verification-methodZpůsob ověření TOTPToken uživatelského panelu
PUT /api/v1/user – Úprava profilu

Přístup: token uživatelského panelu

PUT/api/v1/user

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
usernamestringne; může být null
avatar_urlstringne; může být null
balance_notify_enabledbooleanne; může být null
balance_notify_thresholdnumberne; může být null
Šablona těla požadavku
{
  "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 ponechte pouze potřebná nepovinná pole; řetězcové zástupné značky se neodesílají místo čísel, hodnot typu boolean, objektů nebo polí.

Schéma požadavku: UpdateProfileRequest

Odpověď

Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.

Datová schémata odpovědi: User, UserProfileResponse. Pole a typy najdete na stránkách „Datová schémata“.

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "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)"
  }
}

Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.

Specifika: operace mění stav nebo pokračuje v jednorázové autorizaci; příklad popisuje kontrakt a neprovádí se.

Specifika: výdajové limity klíčů (quota, quota_used) jsou v odpovědi pro klíče, nikoli v profilu. frozen_balance je rezervovaná částka a nelze ji považovat za volný zůstatek.

GET /api/v1/user/passkeys – Seznam přístupových klíčů (passkey)

Přístup: token uživatelského panelu

GET/api/v1/user/passkeys
Čtení; ID pochází z vaší předchozí odpovědi
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

Tělo požadavku není potřeba. Výše uvedené parametry předávejte v URL.

Odpověď

Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.

Datová schémata odpovědi: PasskeyCredentialSummary. Pole a typy najdete na stránkách „Datová schémata“.

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "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)"
  }
}

Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.

Specifika: credential pochází z navigator.credentials; session_token z begin. Tělo požadavku Finish <=65536 bajtů; registrace a odstranění vyžadují heslo.

PUT /api/v1/user/password – Změna hesla

Přístup: token uživatelského panelu

PUT/api/v1/user/password

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
old_passwordstringanorequired
new_passwordstringanorequired,min=6
Šablona těla požadavku
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER označuje váš vstup a jeho typ. Nahraďte hodnoty a ponechte pouze potřebná nepovinná pole; řetězcové zástupné značky se neodesílají místo čísel, hodnot typu boolean, objektů nebo polí.

Schéma požadavku: ChangePasswordRequest

Odpověď

Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.

Specifika: operace mění stav nebo pokračuje v jednorázové autorizaci; příklad popisuje kontrakt a neprovádí se.

GET /api/v1/user/profile – Profil, zůstatek a propojení

Přístup: token uživatelského panelu

GET/api/v1/user/profile
Čtení; ID pochází z vaší předchozí odpovědi
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Tělo požadavku není potřeba. Výše uvedené parametry předávejte v URL.

Odpověď

Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.

Datová schémata odpovědi: User, UserProfileResponse. Pole a typy najdete na stránkách „Datová schémata“.

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "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)"
  }
}

Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.

Specifika: výdajové limity klíčů (quota, quota_used) jsou v odpovědi pro klíče, nikoli v profilu. frozen_balance je rezervovaná částka a nelze ji považovat za volný zůstatek.

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

Přístup: token uživatelského panelu

GET/api/v1/user/totp/status
Čtení; ID pochází z vaší předchozí odpovědi
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

Tělo požadavku není potřeba. Výše uvedené parametry předávejte v URL.

Odpověď

Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.

Datová schémata odpovědi: TotpStatusResponse. Pole a typy najdete na stránkách „Datová schémata“.

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.

Specifika: secret a setup_token jsou tajné; ověření závisí na nastavení TOTP a uživatele.

GET /api/v1/user/totp/verification-method – Způsob ověření TOTP

Přístup: token uživatelského panelu

GET/api/v1/user/totp/verification-method
Čtení; ID pochází z vaší předchozí odpovědi
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

Tělo požadavku není potřeba. Výše uvedené parametry předávejte v URL.

Odpověď

Odpověď JSON obsahuje code, message a data. Obsah data je popsán ve schématech níže.

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

Specifika: všechny osobní údaje a objekty jsou omezeny na subjekt JWT.

Specifika: secret a setup_token jsou tajné; ověření závisí na nastavení TOTP a uživatele.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
Máte další dotazy? Pošlete Request ID a popis – pomůžeme situaci objasnit.Napsat podpoře