dokumentace
API uživatelského panelu

Přihlášení a relace

Markdown

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

Úplný průvodce

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

Metoda a cestaPopisPřístup
POST /api/v1/auth/forgot-passwordŽádost o reset heslaBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/loginPřihlášení e-mailem a heslemBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/login/2faDokončení přihlášení s TOTPBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/logoutOdhlášení a zneplatnění obnovovacího tokenu (refresh token)Bez přihlášení; další podmínky jsou uvedeny u metody
GET /api/v1/auth/meAktuální uživatel, zůstatek a limityToken uživatelského panelu
POST /api/v1/auth/passkey/login/beginZahájení přihlášení pomocí passkeyBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/passkey/login/finishDokončení přihlášení pomocí passkeyBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/refreshObnovení tokenůBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/registerRegistraceBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/reset-passwordReset heslaBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/revoke-all-sessionsZneplatnění všech relacíToken uživatelského panelu
POST /api/v1/auth/send-verify-codeOdeslání potvrzovacího kóduBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/validate-invitation-codeOvěření pozvánkyBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/validate-promo-codeOvěření promo kóduBez přihlášení; další podmínky jsou uvedeny u metody
POST /api/v1/auth/forgot-password – Žádost o reset hesla

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Limit četnosti: 5 požadavků za 60 sekund z jedné adresy.

POST/api/v1/auth/forgot-password

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
turnstile_tokenstringne
Šablona těla požadavku
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (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: ForgotPasswordRequest

Odpověď

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

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

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

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

POST /api/v1/auth/login – Přihlášení e-mailem a heslem

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Dostupnost funkce a další podmínky přístupu se ověřují při zpracování požadavku.

Limit četnosti: 20 požadavků za 60 sekund z jedné adresy.

POST/api/v1/auth/login

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
passwordstringanorequired
turnstile_tokenstringne
Šablona těla požadavku
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (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: LoginRequest

Odpověď

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

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

Pokud je možných několik variant odpovědi, jejich pole jsou uvedena v samostatných schématech; neslučujte je do jednoho objektu.

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

POST /api/v1/auth/login/2fa – Dokončení přihlášení s TOTP

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Dostupnost funkce a další podmínky přístupu se ověřují při zpracování požadavku.

Limit četnosti: 20 požadavků za 60 sekund z jedné adresy.

POST/api/v1/auth/login/2fa

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
temp_tokenstringanorequired
totp_codestringanorequired,len=6
Šablona těla požadavku
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (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: Login2FARequest

Odpověď

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

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

Pokud je možných několik variant odpovědi, jejich pole jsou uvedena v samostatných schématech; neslučujte je do jednoho objektu.

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

POST /api/v1/auth/logout – Odhlášení a zneplatnění obnovovacího tokenu (refresh token)

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

POST/api/v1/auth/logout

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
refresh_tokenstringne; Nepovinné: zneplatnit uvedený obnovovací token
Šablona těla požadavku
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (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: LogoutRequest

Odpověď

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

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

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

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

GET /api/v1/auth/me – Aktuální uživatel, zůstatek a limity

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

GET/api/v1/auth/me
Čtení; ID pochází z vaší předchozí odpovědi
curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -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.

POST /api/v1/auth/passkey/login/begin – Zahájení přihlášení pomocí passkey

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Dostupnost funkce a další podmínky přístupu se ověřují při zpracování požadavku.

Limit četnosti: 20 požadavků za 60 sekund z jedné adresy.

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

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
turnstile_tokenstringne
Šablona těla požadavku
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (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: PasskeyBeginLoginRequest

Odpověď

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

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

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}

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

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.

POST /api/v1/auth/passkey/login/finish – Dokončení přihlášení pomocí passkey

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Dostupnost funkce a další podmínky přístupu se ověřují při zpracování požadavku.

Limit četnosti: 20 požadavků za 60 sekund z jedné adresy.

POST/api/v1/auth/passkey/login/finish

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
session_tokenstringanorequired
namestringne
credentialobjectanorequired
Šablona těla požadavku
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

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: PasskeyFinishRequest

Odpověď

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

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

Pokud je možných několik variant odpovědi, jejich pole jsou uvedena v samostatných schématech; neslučujte je do jednoho objektu.

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

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.

POST /api/v1/auth/refresh – Obnovení tokenů

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Dostupnost funkce a další podmínky přístupu se ověřují při zpracování požadavku.

Limit četnosti: 30 požadavků za 60 sekund z jedné adresy.

POST/api/v1/auth/refresh

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
refresh_tokenstringanorequired
Šablona těla požadavku
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (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: RefreshTokenRequest

Odpověď

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

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

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

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

POST /api/v1/auth/register – Registrace

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Limit četnosti: 5 požadavků za 60 sekund z jedné adresy.

POST/api/v1/auth/register

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
passwordstringanorequired,min=6
verify_codestringne
turnstile_tokenstringne
promo_codestringne; Registrační promo kód
invitation_codestringne; Kód pozvánky
Šablona těla požadavku
{
  "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 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: RegisterRequest

Odpověď

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

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

Pokud je možných několik variant odpovědi, jejich pole jsou uvedena v samostatných schématech; neslučujte je do jednoho objektu.

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

POST /api/v1/auth/reset-password – Reset hesla

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Limit četnosti: 10 požadavků za 60 sekund z jedné adresy.

POST/api/v1/auth/reset-password

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
tokenstringanorequired
new_passwordstringanorequired,min=6
Šablona těla požadavku
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (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: ResetPasswordRequest

Odpověď

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

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

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

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

POST /api/v1/auth/revoke-all-sessions – Zneplatnění všech relací

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

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

Tělo požadavku není potřeba.

Odpověď

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

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

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

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.

POST /api/v1/auth/send-verify-code – Odeslání potvrzovacího kódu

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Limit četnosti: 5 požadavků za 60 sekund z jedné adresy.

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

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
turnstile_tokenstringne
Šablona těla požadavku
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (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: SendVerifyCodeRequest

Odpověď

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

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

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}

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

POST /api/v1/auth/validate-invitation-code – Ověření pozvánky

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Dostupnost funkce a další podmínky přístupu se ověřují při zpracování požadavku.

Limit četnosti: 10 požadavků za 60 sekund z jedné adresy.

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

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
codestringanorequired
Šablona těla požadavku
{
  "code": "PLACEHOLDER_CODE (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: ValidateInvitationCodeRequest

Odpověď

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

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

Schéma odpovědi, hodnoty jsou ilustrativní
{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}

Vlastnosti: Metoda ověřuje pozvánku a kód nespotřebuje; příklad popisuje kontrakt API a neprovádí se.

POST /api/v1/auth/validate-promo-code – Ověření promo kódu

Přístup: bez přihlášení; další podmínky jsou uvedeny u metody

Dostupnost funkce a další podmínky přístupu se ověřují při zpracování požadavku.

Limit četnosti: 10 požadavků za 60 sekund z jedné adresy.

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

Pole JSON / formuláře

PoleTypPovinnéKontrola / popis
codestringanorequired
Šablona těla požadavku
{
  "code": "PLACEHOLDER_CODE (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: ValidatePromoCodeRequest

Odpověď

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

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

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

Vlastnosti: Metoda ověřuje promo kód a nepřipisuje bonus; příklad popisuje kontrakt API a neprovádí se.

Přihlášení a relace · 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

Máte další dotazy? Pošlete Request ID a popis – pomůžeme situaci objasnit.Napsat podpoře