documentatie
Dashboard-API

Profiel en beveiliging

Markdown

Methoden, verzoekvelden en antwoorden.

Volledige gids

Dit onderdeel bevat 6 methoden. Open een methode om de toegangsvoorwaarden, verzoekvelden en het antwoord te bekijken.

Methode en padBeschrijvingToegang
PUT /api/v1/userProfiel wijzigenDashboardtoken
GET /api/v1/user/passkeysPasskeylijstDashboardtoken
PUT /api/v1/user/passwordWachtwoord wijzigenDashboardtoken
GET /api/v1/user/profileProfiel, saldo en koppelingenDashboardtoken
GET /api/v1/user/totp/status2FA-status (TOTP)Dashboardtoken
GET /api/v1/user/totp/verification-methodTOTP-verificatiemethodeDashboardtoken
PUT /api/v1/user — Profiel wijzigen

Toegang: dashboardtoken

PUT/api/v1/user

JSON- / formuliervelden

VeldTypeVerplichtValidatie / beschrijving
usernamestringnee; kan null zijn
avatar_urlstringnee; kan null zijn
balance_notify_enabledbooleannee; kan null zijn
balance_notify_thresholdnumbernee; kan null zijn
Sjabloon voor de verzoekbody
{
  "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 geeft jouw invoer en het bijbehorende type aan. Vervang de waarden en behoud alleen de benodigde optionele velden; verstuur stringmarkeringen niet in plaats van getallen, boolean, objecten of arrays.

Verzoekschema: UpdateProfileRequest

Antwoord

Het JSON-antwoord bevat code, message en data. De inhoud van data wordt beschreven in de schema’s hieronder.

Gegevensschema’s van het antwoord: User, UserProfileResponse. Velden en typen staan op de pagina’s “Gegevensschema’s”.

Antwoordschema met voorbeeldwaarden
{
  "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)"
  }
}

Bijzonderheden: alle persoonsgegevens en objecten zijn beperkt tot het subject van de JWT.

Bijzonderheden: de bewerking wijzigt de toestand of zet een eenmalige autorisatie voort; het voorbeeld beschrijft het contract en wordt niet uitgevoerd.

Bijzonderheden: de bestedingslimieten van sleutels (quota, quota_used) staan in het sleutelantwoord, niet in het profiel. frozen_balance is het gereserveerde bedrag; je kunt dat niet als vrij saldo beschouwen.

GET /api/v1/user/passkeys — Passkeylijst

Toegang: dashboardtoken

GET/api/v1/user/passkeys
Leesbewerking; de ID komt uit je vorige antwoord
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"

Er is geen verzoekbody nodig. Geef de hierboven genoemde parameters mee in de URL.

Antwoord

Het JSON-antwoord bevat code, message en data. De inhoud van data wordt beschreven in de schema’s hieronder.

Gegevensschema’s van het antwoord: PasskeyCredentialSummary. Velden en typen staan op de pagina’s “Gegevensschema’s”.

Antwoordschema met voorbeeldwaarden
{
  "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)"
  }
}

Bijzonderheden: alle persoonsgegevens en objecten zijn beperkt tot het subject van de JWT.

Bijzonderheden: credential komt uit navigator.credentials; session_token uit begin. De finish-body is <=65536 bytes; passkeyregistratie en -verwijdering vereisen een wachtwoord.

PUT /api/v1/user/password — Wachtwoord wijzigen

Toegang: dashboardtoken

PUT/api/v1/user/password

JSON- / formuliervelden

VeldTypeVerplichtValidatie / beschrijving
old_passwordstringjarequired
new_passwordstringjarequired,min=6
Sjabloon voor de verzoekbody
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

PLACEHOLDER geeft jouw invoer en het bijbehorende type aan. Vervang de waarden en behoud alleen de benodigde optionele velden; verstuur stringmarkeringen niet in plaats van getallen, boolean, objecten of arrays.

Verzoekschema: ChangePasswordRequest

Antwoord

Het JSON-antwoord bevat code, message en data. De inhoud van data wordt beschreven in de schema’s hieronder.

Antwoordschema met voorbeeldwaarden
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}

Bijzonderheden: alle persoonsgegevens en objecten zijn beperkt tot het subject van de JWT.

Bijzonderheden: de bewerking wijzigt de toestand of zet een eenmalige autorisatie voort; het voorbeeld beschrijft het contract en wordt niet uitgevoerd.

GET /api/v1/user/profile — Profiel, saldo en koppelingen

Toegang: dashboardtoken

GET/api/v1/user/profile
Leesbewerking; de ID komt uit je vorige antwoord
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Er is geen verzoekbody nodig. Geef de hierboven genoemde parameters mee in de URL.

Antwoord

Het JSON-antwoord bevat code, message en data. De inhoud van data wordt beschreven in de schema’s hieronder.

Gegevensschema’s van het antwoord: User, UserProfileResponse. Velden en typen staan op de pagina’s “Gegevensschema’s”.

Antwoordschema met voorbeeldwaarden
{
  "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)"
  }
}

Bijzonderheden: alle persoonsgegevens en objecten zijn beperkt tot het subject van de JWT.

Bijzonderheden: de bestedingslimieten van sleutels (quota, quota_used) staan in het sleutelantwoord, niet in het profiel. frozen_balance is het gereserveerde bedrag; je kunt dat niet als vrij saldo beschouwen.

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

Toegang: dashboardtoken

GET/api/v1/user/totp/status
Leesbewerking; de ID komt uit je vorige antwoord
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"

Er is geen verzoekbody nodig. Geef de hierboven genoemde parameters mee in de URL.

Antwoord

Het JSON-antwoord bevat code, message en data. De inhoud van data wordt beschreven in de schema’s hieronder.

Gegevensschema’s van het antwoord: TotpStatusResponse. Velden en typen staan op de pagina’s “Gegevensschema’s”.

Antwoordschema met voorbeeldwaarden
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}

Bijzonderheden: alle persoonsgegevens en objecten zijn beperkt tot het subject van de JWT.

Bijzonderheden: secret en setup_token zijn geheim; de verificatie hangt af van de TOTP- en gebruikersinstellingen.

GET /api/v1/user/totp/verification-method — TOTP-verificatiemethode

Toegang: dashboardtoken

GET/api/v1/user/totp/verification-method
Leesbewerking; de ID komt uit je vorige antwoord
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"

Er is geen verzoekbody nodig. Geef de hierboven genoemde parameters mee in de URL.

Antwoord

Het JSON-antwoord bevat code, message en data. De inhoud van data wordt beschreven in de schema’s hieronder.

Antwoordschema met voorbeeldwaarden
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}

Bijzonderheden: alle persoonsgegevens en objecten zijn beperkt tot het subject van de JWT.

Bijzonderheden: secret en setup_token zijn geheim; de verificatie hangt af van de TOTP- en gebruikersinstellingen.

TotpVerificationMethod

{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
Nog vragen? Stuur de Request ID en een beschrijving — we helpen je verder.Contact opnemen met support