Přihlášení a relace
MarkdownMetody, 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 cesta | Popis | Přístup |
|---|---|---|
POST /api/v1/auth/forgot-password | Žádost o reset hesla | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/login | Přihlášení e-mailem a heslem | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/login/2fa | Dokončení přihlášení s TOTP | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/logout | Odhlášení a zneplatnění obnovovacího tokenu (refresh token) | Bez přihlášení; další podmínky jsou uvedeny u metody |
GET /api/v1/auth/me | Aktuální uživatel, zůstatek a limity | Token uživatelského panelu |
POST /api/v1/auth/passkey/login/begin | Zahájení přihlášení pomocí passkey | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/passkey/login/finish | Dokončení přihlášení pomocí passkey | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/refresh | Obnovení tokenů | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/register | Registrace | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/reset-password | Reset hesla | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/revoke-all-sessions | Zneplatnění všech relací | Token uživatelského panelu |
POST /api/v1/auth/send-verify-code | Odeslání potvrzovacího kódu | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/validate-invitation-code | Ověření pozvánky | Bez přihlášení; další podmínky jsou uvedeny u metody |
POST /api/v1/auth/validate-promo-code | Ověření promo kódu | Bez 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.
/api/v1/auth/forgot-passwordPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
email | string | ano | required,email |
turnstile_token | string | ne |
{
"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“.
{
"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.
/api/v1/auth/loginPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
email | string | ano | required,email |
password | string | ano | required |
turnstile_token | string | ne |
{
"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.
/api/v1/auth/login/2faPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
temp_token | string | ano | required |
totp_code | string | ano | required,len=6 |
{
"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
/api/v1/auth/logoutPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
refresh_token | string | ne | ; Nepovinné: zneplatnit uvedený obnovovací token |
{
"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“.
{
"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
/api/v1/auth/mecurl --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“.
{
"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.
/api/v1/auth/passkey/login/beginPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
turnstile_token | string | ne |
{
"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“.
{
"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.
/api/v1/auth/passkey/login/finishPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
session_token | string | ano | required |
name | string | ne | |
credential | object | ano | required |
{
"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.
/api/v1/auth/refreshPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
refresh_token | string | ano | required |
{
"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“.
{
"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.
/api/v1/auth/registerPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
email | string | ano | required,email |
password | string | ano | required,min=6 |
verify_code | string | ne | |
turnstile_token | string | ne | |
promo_code | string | ne | ; Registrační promo kód |
invitation_code | string | ne | ; Kód pozvánky |
{
"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.
/api/v1/auth/reset-passwordPole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
email | string | ano | required,email |
token | string | ano | required |
new_password | string | ano | required,min=6 |
{
"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“.
{
"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
/api/v1/auth/revoke-all-sessionsTě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“.
{
"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.
/api/v1/auth/send-verify-codePole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
email | string | ano | required,email |
turnstile_token | string | ne |
{
"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“.
{
"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.
/api/v1/auth/validate-invitation-codePole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
code | string | ano | required |
{
"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“.
{
"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.
/api/v1/auth/validate-promo-codePole JSON / formuláře
| Pole | Typ | Povinné | Kontrola / popis |
|---|---|---|---|
code | string | ano | required |
{
"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“.
{
"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_tokendata.access_token→ AuthResponse →Authorization: Bearer $TOKEN
totp_code: string, len = 6. temp_token ≠ access_token. User