Aanmelden en sessies

Methoden, verzoekvelden en antwoorden.

Volledige gids

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

Methode en pad	Beschrijving	Toegang
`POST /api/v1/auth/forgot-password`	Verzoek om het wachtwoord opnieuw in te stellen	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/login`	Aanmelden met e-mailadres en wachtwoord	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/login/2fa`	Aanmelden met TOTP voltooien	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/logout`	Afmelden en refresh token intrekken	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`GET /api/v1/auth/me`	Huidige gebruiker, saldo en limieten	Dashboardtoken
`POST /api/v1/auth/passkey/login/begin`	Aanmelden met een passkey starten	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/passkey/login/finish`	Aanmelden met een passkey voltooien	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/refresh`	Tokens vernieuwen	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/register`	Registreren	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/reset-password`	Wachtwoord opnieuw instellen	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/revoke-all-sessions`	Alle sessies intrekken	Dashboardtoken
`POST /api/v1/auth/send-verify-code`	Bevestigingscode versturen	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/validate-invitation-code`	Uitnodiging controleren	Zonder aanmelding; aanvullende voorwaarden staan bij de methode
`POST /api/v1/auth/validate-promo-code`	Promotiecode controleren	Zonder aanmelding; aanvullende voorwaarden staan bij de methode

POST /api/v1/auth/forgot-password — Verzoek om het wachtwoord opnieuw in te stellen

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

Frequentielimiet: 5 verzoeken per 60 seconden vanaf één adres.

POST/api/v1/auth/forgot-password

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`email`	`string`	ja	required,email
`turnstile_token`	`string`	nee

Sjabloon voor de verzoekbody

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (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: ForgotPasswordRequest

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: ForgotPasswordResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

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

POST /api/v1/auth/login — Aanmelden met e-mailadres en wachtwoord

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

De beschikbaarheid van de functie en aanvullende toegangsvoorwaarden worden tijdens het verzoek gecontroleerd.

Frequentielimiet: 20 verzoeken per 60 seconden vanaf één adres.

POST/api/v1/auth/login

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`email`	`string`	ja	required,email
`password`	`string`	ja	required
`turnstile_token`	`string`	nee

Sjabloon voor de verzoekbody

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

Verzoekschema: LoginRequest

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: TotpLoginResponse, User, AuthResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Bij meerdere mogelijke antwoordvarianten staan de velden daarvan in afzonderlijke schema’s; voeg ze niet samen tot één object.

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

POST /api/v1/auth/login/2fa — Aanmelden met TOTP voltooien

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

De beschikbaarheid van de functie en aanvullende toegangsvoorwaarden worden tijdens het verzoek gecontroleerd.

Frequentielimiet: 20 verzoeken per 60 seconden vanaf één adres.

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

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`temp_token`	`string`	ja	required
`totp_code`	`string`	ja	required,len=6

Sjabloon voor de verzoekbody

{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

Verzoekschema: Login2FARequest

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, AuthResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Bij meerdere mogelijke antwoordvarianten staan de velden daarvan in afzonderlijke schema’s; voeg ze niet samen tot één object.

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

POST /api/v1/auth/logout — Afmelden en refresh token intrekken

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

POST/api/v1/auth/logout

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`refresh_token`	`string`	nee	; Optioneel: het opgegeven refresh token intrekken

Sjabloon voor de verzoekbody

{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

Verzoekschema: LogoutRequest

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: LogoutResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

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

GET /api/v1/auth/me — Huidige gebruiker, saldo en limieten

Toegang: dashboardtoken

GET/api/v1/auth/me

Leesbewerking; de ID komt uit je vorige antwoord

curl --fail-with-body "https://ailoot.ai/api/v1/auth/me" \
  -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.

POST /api/v1/auth/passkey/login/begin — Aanmelden met een passkey starten

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

De beschikbaarheid van de functie en aanvullende toegangsvoorwaarden worden tijdens het verzoek gecontroleerd.

Frequentielimiet: 20 verzoeken per 60 seconden vanaf één adres.

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

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`turnstile_token`	`string`	nee

Sjabloon voor de verzoekbody

{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

Verzoekschema: PasskeyBeginLoginRequest

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: PasskeyOptionsResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

{
  "code": 0,
  "message": "success",
  "data": {
    "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
    "options": "PLACEHOLDER_OPTIONS (any)"
  }
}

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

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

POST /api/v1/auth/passkey/login/finish — Aanmelden met een passkey voltooien

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

De beschikbaarheid van de functie en aanvullende toegangsvoorwaarden worden tijdens het verzoek gecontroleerd.

Frequentielimiet: 20 verzoeken per 60 seconden vanaf één adres.

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

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`session_token`	`string`	ja	required
`name`	`string`	nee
`credential`	`object`	ja	required

Sjabloon voor de verzoekbody

{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

Verzoekschema: PasskeyFinishRequest

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, AuthResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Bij meerdere mogelijke antwoordvarianten staan de velden daarvan in afzonderlijke schema’s; voeg ze niet samen tot één object.

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

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

POST /api/v1/auth/refresh — Tokens vernieuwen

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

De beschikbaarheid van de functie en aanvullende toegangsvoorwaarden worden tijdens het verzoek gecontroleerd.

Frequentielimiet: 30 verzoeken per 60 seconden vanaf één adres.

POST/api/v1/auth/refresh

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`refresh_token`	`string`	ja	required

Sjabloon voor de verzoekbody

{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

Verzoekschema: RefreshTokenRequest

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: RefreshTokenResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

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

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

POST /api/v1/auth/register — Registreren

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

Frequentielimiet: 5 verzoeken per 60 seconden vanaf één adres.

POST/api/v1/auth/register

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`email`	`string`	ja	required,email
`password`	`string`	ja	required,min=6
`verify_code`	`string`	nee
`turnstile_token`	`string`	nee
`promo_code`	`string`	nee	; Promotiecode voor registratie
`invitation_code`	`string`	nee	; Uitnodigingscode

Sjabloon voor de verzoekbody

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

Verzoekschema: RegisterRequest

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, AuthResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Bij meerdere mogelijke antwoordvarianten staan de velden daarvan in afzonderlijke schema’s; voeg ze niet samen tot één object.

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

POST /api/v1/auth/reset-password — Wachtwoord opnieuw instellen

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

Frequentielimiet: 10 verzoeken per 60 seconden vanaf één adres.

POST/api/v1/auth/reset-password

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`email`	`string`	ja	required,email
`token`	`string`	ja	required
`new_password`	`string`	ja	required,min=6

Sjabloon voor de verzoekbody

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

Verzoekschema: ResetPasswordRequest

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: ResetPasswordResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

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

POST /api/v1/auth/revoke-all-sessions — Alle sessies intrekken

Toegang: dashboardtoken

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

Er is geen verzoekbody nodig.

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: RevokeAllSessionsResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)"
  }
}

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.

POST /api/v1/auth/send-verify-code — Bevestigingscode versturen

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

Frequentielimiet: 5 verzoeken per 60 seconden vanaf één adres.

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

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`email`	`string`	ja	required,email
`turnstile_token`	`string`	nee

Sjabloon voor de verzoekbody

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

Verzoekschema: SendVerifyCodeRequest

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: SendVerifyCodeResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

{
  "code": 0,
  "message": "success",
  "data": {
    "message": "PLACEHOLDER_MESSAGE (string)",
    "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
  }
}

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

POST /api/v1/auth/validate-invitation-code — Uitnodiging controleren

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

De beschikbaarheid van de functie en aanvullende toegangsvoorwaarden worden tijdens het verzoek gecontroleerd.

Frequentielimiet: 10 verzoeken per 60 seconden vanaf één adres.

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

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`code`	`string`	ja	required

Sjabloon voor de verzoekbody

{
  "code": "PLACEHOLDER_CODE (string)"
}

Verzoekschema: ValidateInvitationCodeRequest

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: ValidateInvitationCodeResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

{
  "code": 0,
  "message": "success",
  "data": {
    "valid": "PLACEHOLDER_VALID (boolean)",
    "error_code": "PLACEHOLDER_ERROR_CODE (string)"
  }
}

Bijzonderheden: de methode controleert de uitnodiging zonder de code als gebruikt te markeren; het voorbeeld beschrijft het contract en wordt niet uitgevoerd.

POST /api/v1/auth/validate-promo-code — Promotiecode controleren

Toegang: zonder aanmelding; aanvullende voorwaarden staan bij de methode

De beschikbaarheid van de functie en aanvullende toegangsvoorwaarden worden tijdens het verzoek gecontroleerd.

Frequentielimiet: 10 verzoeken per 60 seconden vanaf één adres.

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

JSON- of formuliervelden

Het veld	Type	Verplicht	Validatie / beschrijving
`code`	`string`	ja	required

Sjabloon voor de verzoekbody

{
  "code": "PLACEHOLDER_CODE (string)"
}

Verzoekschema: ValidatePromoCodeRequest

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: ValidatePromoCodeResponse. Velden en typen staan op de pagina’s ‘Gegevensschema’s’.

Antwoordschema met voorbeeldwaarden

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

Bijzonderheden: de methode controleert de promotiecode zonder een bonus toe te kennen; het voorbeeld beschrijft het contract en wordt niet uitgevoerd.

Aanmelden en sessies · 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

Nog vragen? Stuur de Request ID en een beschrijving — we helpen je verder.Contact opnemen met support