dokumentation
Kontrollpanelens API

Profil och säkerhet

Markdown

Metoder, anropsfält och svar.

Fullständig guide

Avsnittet innehåller 6 metoder. Öppna en metod för att se åtkomstvillkor, anropsfält och svar.

Metod och sökvägBeskrivningÅtkomst
PUT /api/v1/userÄndra profilKontrollpaneltoken
GET /api/v1/user/passkeysLista över passnycklarKontrollpaneltoken
PUT /api/v1/user/passwordÄndra lösenordKontrollpaneltoken
GET /api/v1/user/profileProfil, saldo och kopplingarKontrollpaneltoken
GET /api/v1/user/totp/status2FA-status (TOTP)Kontrollpaneltoken
GET /api/v1/user/totp/verification-methodMetod för TOTP-verifieringKontrollpaneltoken
PUT /api/v1/user — Ändra profil

Åtkomst: kontrollpaneltoken

PUT/api/v1/user

JSON-/formulärfält

FältetTypObligatorisktValidering / beskrivning
usernamestringnej; kan vara null
avatar_urlstringnej; kan vara null
balance_notify_enabledbooleannej; kan vara null
balance_notify_thresholdnumbernej; kan vara null
Mall för anropskropp
{
  "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 anger dina indata och deras typ. Ersätt värdena och behåll endast de valfria fält du behöver; strängmarkörer ska inte skickas i stället för tal, boolean, objekt eller arrayer.

Anropsschema: UpdateProfileRequest

Svar

JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.

Datascheman för svaret: User, UserProfileResponse. Fält och typer finns på sidorna ”Datascheman”.

Svarsschema med exempelvärden
{
  "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)"
  }
}

Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.

Observera: Operationen ändrar tillstånd eller fortsätter en engångsautentisering; exemplet beskriver kontraktet och körs inte.

Observera: Nycklarnas utgiftsgränser (quota, quota_used) returneras i nyckelsvaret, inte i profilen. frozen_balance är reserverat belopp och ska inte räknas som tillgängligt saldo.

GET /api/v1/user/passkeys — Lista över passnycklar

Åtkomst: kontrollpaneltoken

GET/api/v1/user/passkeys
Läsning; ID hämtas från ditt föregående svar
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

Ingen anropskropp krävs. Skicka parametrarna ovan i URL:en.

Svar

JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.

Datascheman för svaret: PasskeyCredentialSummary. Fält och typer finns på sidorna ”Datascheman”.

Svarsschema med exempelvärden
{
  "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)"
  }
}

Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.

Observera: credential hämtas från navigator.credentials; session_token från begin. Anropskroppen till Finish <=65536 byte; registrering och borttagning kräver lösenord.

PUT /api/v1/user/password — Ändra lösenord

Åtkomst: kontrollpaneltoken

PUT/api/v1/user/password

JSON-/formulärfält

FältetTypObligatorisktValidering / beskrivning
old_passwordstringjarequired
new_passwordstringjarequired,min=6
Mall för anropskropp
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER anger dina indata och deras typ. Ersätt värdena och behåll endast de valfria fält du behöver; strängmarkörer ska inte skickas i stället för tal, boolean, objekt eller arrayer.

Anropsschema: ChangePasswordRequest

Svar

JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.

Svarsschema med exempelvärden
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.

Observera: Operationen ändrar tillstånd eller fortsätter en engångsautentisering; exemplet beskriver kontraktet och körs inte.

GET /api/v1/user/profile — Profil, saldo och kopplingar

Åtkomst: kontrollpaneltoken

GET/api/v1/user/profile
Läsning; ID hämtas från ditt föregående svar
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Ingen anropskropp krävs. Skicka parametrarna ovan i URL:en.

Svar

JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.

Datascheman för svaret: User, UserProfileResponse. Fält och typer finns på sidorna ”Datascheman”.

Svarsschema med exempelvärden
{
  "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)"
  }
}

Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.

Observera: Nycklarnas utgiftsgränser (quota, quota_used) returneras i nyckelsvaret, inte i profilen. frozen_balance är reserverat belopp och ska inte räknas som tillgängligt saldo.

GET /api/v1/user/totp/status — 2FA-status (TOTP)

Åtkomst: kontrollpaneltoken

GET/api/v1/user/totp/status
Läsning; ID hämtas från ditt föregående svar
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

Ingen anropskropp krävs. Skicka parametrarna ovan i URL:en.

Svar

JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.

Datascheman för svaret: TotpStatusResponse. Fält och typer finns på sidorna ”Datascheman”.

Svarsschema med exempelvärden
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.

Observera: secret och setup_token är hemliga; verifieringen beror på TOTP-inställningarna och användaren.

GET /api/v1/user/totp/verification-method — Metod för TOTP-verifiering

Åtkomst: kontrollpaneltoken

GET/api/v1/user/totp/verification-method
Läsning; ID hämtas från ditt föregående svar
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

Ingen anropskropp krävs. Skicka parametrarna ovan i URL:en.

Svar

JSON-svaret innehåller code, message och data. Innehållet i data beskrivs i schemana nedan.

Svarsschema med exempelvärden
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

Observera: Alla personuppgifter och objekt är begränsade till JWT-subjektet.

Observera: secret och setup_token är hemliga; verifieringen beror på TOTP-inställningarna och användaren.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
Har du fler frågor? Skicka Request ID och en beskrivning, så hjälper vi dig.Kontakta supporten