documentatie
Dashboard
Dashboard-API

Gegevensschema’s

Markdown

Velden en typen van dashboard-API-objecten.

Volledige gids

Velden en typen van dashboard-API-objecten. omitempty betekent dat een veld in het antwoord kan ontbreken; dat geeft geen toestemming om null te versturen. PLACEHOLDER-strings geven het type aan, niet het echte antwoord.

APIKey

VeldTypeVerplichtValidatie / beschrijving
idintegernee
user_idintegernee
keystringnee
namestringnee
statusstringnee
ip_whitelistarray · items: stringnee
ip_blacklistarray · items: stringnee
last_used_atstringnee; kan null zijn
last_used_ipstringnee; kan null zijn
quotanumbernee; Bestedingslimiet van de sleutel in USD; 0 — geen limiet
quota_usednumbernee; Al besteed uit de sleutellimiet, USD
expires_atstringnee; Geldigheidsduur; null — geen vervaldatum; kan null zijn
created_atstringnee
updated_atstringnee
current_concurrencyintegernee
rate_limit_5hnumbernee
rate_limit_1dnumbernee
rate_limit_7dnumbernee
usage_5hnumbernee
usage_1dnumbernee
usage_7dnumbernee
window_5h_startstringnee; kan null zijn
window_1d_startstringnee; kan null zijn
window_7d_startstringnee; kan null zijn
reset_5h_atstringnee; kan null zijn
reset_1d_atstringnee; kan null zijn
reset_7d_atstringnee; kan null zijn
userobject · Usernee; kan null zijn
Objectvelden
{
  "id": "PLACEHOLDER_ID (integer)",
  "user_id": "PLACEHOLDER_USER_ID (integer)",
  "key": "PLACEHOLDER_KEY (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "status": "PLACEHOLDER_STATUS (string)",
  "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
  "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
  "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
  "last_used_ip": "PLACEHOLDER_LAST_USED_IP (string)",
  "quota": "PLACEHOLDER_QUOTA (number)",
  "quota_used": "PLACEHOLDER_QUOTA_USED (number)",
  "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
  "created_at": "PLACEHOLDER_CREATED_AT (string)",
  "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
  "current_concurrency": "PLACEHOLDER_CURRENT_CONCURRENCY (integer)",
  "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
  "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
  "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)",
  "usage_5h": "PLACEHOLDER_USAGE_5H (number)",
  "usage_1d": "PLACEHOLDER_USAGE_1D (number)",
  "usage_7d": "PLACEHOLDER_USAGE_7D (number)",
  "window_5h_start": "PLACEHOLDER_WINDOW_5H_START (string)",
  "window_1d_start": "PLACEHOLDER_WINDOW_1D_START (string)",
  "window_7d_start": "PLACEHOLDER_WINDOW_7D_START (string)",
  "reset_5h_at": "PLACEHOLDER_RESET_5H_AT (string)",
  "reset_1d_at": "PLACEHOLDER_RESET_1D_AT (string)",
  "reset_7d_at": "PLACEHOLDER_RESET_7D_AT (string)",
  "user": "PLACEHOLDER_USER (object)"
}

APIKeyDailyUsagePoint

VeldTypeVerplichtValidatie / beschrijving
datestringnee
requestsintegernee
input_tokensintegernee
output_tokensintegernee
cache_read_tokensintegernee
cache_write_tokensintegernee
total_tokensintegernee
costnumbernee; Kosten tegen de standaardprijs
actual_costnumbernee; Daadwerkelijke afschrijving
Objectvelden
{
  "date": "PLACEHOLDER_DATE (string)",
  "requests": "PLACEHOLDER_REQUESTS (integer)",
  "input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
  "output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
  "cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
  "cache_write_tokens": "PLACEHOLDER_CACHE_WRITE_TOKENS (integer)",
  "total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
  "cost": "PLACEHOLDER_COST (number)",
  "actual_cost": "PLACEHOLDER_ACTUAL_COST (number)"
}

AuthResponse

VeldTypeVerplichtValidatie / beschrijving
access_tokenstringnee
refresh_tokenstringnee; Token voor het vernieuwen van de sessie
expires_inintegernee; Geldigheidsduur van de toegangstoken in seconden
token_typestringnee
userobject · Usernee; kan null zijn
Objectvelden
{
  "access_token": "PLACEHOLDER_ACCESS_TOKEN (string)",
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)",
  "expires_in": "PLACEHOLDER_EXPIRES_IN (integer)",
  "token_type": "PLACEHOLDER_TOKEN_TYPE (string)",
  "user": "PLACEHOLDER_USER (object)"
}

BatchAPIKeysUsageRequest

VeldTypeVerplichtValidatie / beschrijving
api_key_idsarray · items: integer (int64)jarequired
Objectvelden
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

VeldTypeVerplichtValidatie / beschrijving
api_key_idintegernee
today_actual_costnumbernee
total_actual_costnumbernee
Objectvelden
{
  "api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
  "today_actual_cost": "PLACEHOLDER_TODAY_ACTUAL_COST (number)",
  "total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)"
}

ChangePasswordRequest

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

CreateAPIKeyRequest

VeldTypeVerplichtValidatie / beschrijving
namestringjarequired
custom_keystringnee; Optionele eigen sleutelwaarde; kan null zijn
ip_whitelistarray · items: stringnee; Lijst met toegestane IP-adressen
ip_blacklistarray · items: stringnee; Lijst met geblokkeerde IP-adressen
quotanumbernee; Bestedingslimiet van de sleutel in USD; kan null zijn
expires_in_daysintegernee; Geldigheidsduur in dagen; kan null zijn
rate_limit_5hnumbernee; kan null zijn
rate_limit_1dnumbernee; kan null zijn
rate_limit_7dnumbernee; kan null zijn
Objectvelden
{
  "name": "PLACEHOLDER_NAME (string)",
  "custom_key": "PLACEHOLDER_CUSTOM_KEY (string)",
  "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
  "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
  "quota": "PLACEHOLDER_QUOTA (number)",
  "expires_in_days": "PLACEHOLDER_EXPIRES_IN_DAYS (integer)",
  "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
  "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
  "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)"
}

ForgotPasswordRequest

VeldTypeVerplichtValidatie / beschrijving
emailstringjarequired,email
turnstile_tokenstringnee
Objectvelden
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

VeldTypeVerplichtValidatie / beschrijving
messagestringnee
Objectvelden
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

VeldTypeVerplichtValidatie / beschrijving
temp_tokenstringjarequired
totp_codestringjarequired,len=6
Objectvelden
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

VeldTypeVerplichtValidatie / beschrijving
emailstringjarequired,email
passwordstringjarequired
turnstile_tokenstringnee
Objectvelden
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

VeldTypeVerplichtValidatie / beschrijving
refresh_tokenstringnee; Optioneel: de opgegeven refresh token intrekken
Objectvelden
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

VeldTypeVerplichtValidatie / beschrijving
messagestringnee
Objectvelden
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

VeldTypeVerplichtValidatie / beschrijving
turnstile_tokenstringnee
Objectvelden
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

VeldTypeVerplichtValidatie / beschrijving
idintegernee
namestringnee
created_atstringnee
last_used_atstringnee; kan null zijn
backupbooleannee
Objectvelden
{
  "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)"
}

PasskeyFinishRequest

VeldTypeVerplichtValidatie / beschrijving
session_tokenstringjarequired
namestringnee
credentialobject · WebAuthn PublicKeyCredential JSONjarequired
Objectvelden
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

VeldTypeVerplichtValidatie / beschrijving
session_tokenstringnee
optionsanynee
Objectvelden
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

VeldTypeVerplichtValidatie / beschrijving
idintegernee
codestringnee
typestringnee
valuenumbernee
statusstringnee
used_byintegernee; kan null zijn
used_atstringnee; kan null zijn
created_atstringnee
expires_atstringnee; kan null zijn
validity_daysintegernee
notesstringnee; kan null zijn
userobject · Usernee; kan null zijn
Objectvelden
{
  "id": "PLACEHOLDER_ID (integer)",
  "code": "PLACEHOLDER_CODE (string)",
  "type": "PLACEHOLDER_TYPE (string)",
  "value": "PLACEHOLDER_VALUE (number)",
  "status": "PLACEHOLDER_STATUS (string)",
  "used_by": "PLACEHOLDER_USED_BY (integer)",
  "used_at": "PLACEHOLDER_USED_AT (string)",
  "created_at": "PLACEHOLDER_CREATED_AT (string)",
  "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
  "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
  "notes": "PLACEHOLDER_NOTES (string)",
  "user": "PLACEHOLDER_USER (object)"
}

RedeemRequest

VeldTypeVerplichtValidatie / beschrijving
codestringjarequired
Objectvelden
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

VeldTypeVerplichtValidatie / beschrijving
refresh_tokenstringjarequired
Objectvelden
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

VeldTypeVerplichtValidatie / beschrijving
access_tokenstringnee
refresh_tokenstringnee
expires_inintegernee; Geldigheidsduur van de toegangstoken in seconden
token_typestringnee
Objectvelden
{
  "access_token": "PLACEHOLDER_ACCESS_TOKEN (string)",
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)",
  "expires_in": "PLACEHOLDER_EXPIRES_IN (integer)",
  "token_type": "PLACEHOLDER_TOKEN_TYPE (string)"
}

RegisterRequest

VeldTypeVerplichtValidatie / beschrijving
emailstringjarequired,email
passwordstringjarequired,min=6
verify_codestringnee
turnstile_tokenstringnee
promo_codestringnee; Promotiecode voor registratie
invitation_codestringnee; Uitnodigingscode
Objectvelden
{
  "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)"
}

ResetPasswordRequest

VeldTypeVerplichtValidatie / beschrijving
emailstringjarequired,email
tokenstringjarequired
new_passwordstringjarequired,min=6
Objectvelden
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

VeldTypeVerplichtValidatie / beschrijving
messagestringnee
Objectvelden
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

VeldTypeVerplichtValidatie / beschrijving
messagestringnee
Objectvelden
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

VeldTypeVerplichtValidatie / beschrijving
emailstringjarequired,email
turnstile_tokenstringnee
Objectvelden
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

VeldTypeVerplichtValidatie / beschrijving
messagestringnee
countdownintegernee; Wachttijd in seconden
Objectvelden
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

VeldTypeVerplichtValidatie / beschrijving
requires_2fabooleannee
temp_tokenstringnee
user_email_maskedstringnee
Objectvelden
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

VeldTypeVerplichtValidatie / beschrijving
enabledbooleannee
enabled_atintegernee; Unix timestamp; kan null zijn
feature_enabledbooleannee
Objectvelden
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

VeldTypeVerplichtValidatie / beschrijving
namestringnee
statusstringneeomitempty,oneof=active inactive
ip_whitelistarray · items: stringnee; Toegestane IP-adressen: null laat de lijst ongewijzigd, een lege array maakt deze leeg; kan null zijn
ip_blacklistarray · items: stringnee; Geblokkeerde IP-adressen: null laat de lijst ongewijzigd, een lege array maakt deze leeg; kan null zijn
quotanumbernee; Bestedingslimiet van de sleutel in USD; 0 — geen limiet; kan null zijn
expires_atstringnee; Vervaldatum in ISO 8601-formaat; kan null zijn
reset_quotabooleannee; Het reeds bestede deel van de bestedingslimiet resetten; kan null zijn
rate_limit_5hnumbernee; kan null zijn
rate_limit_1dnumbernee; kan null zijn
rate_limit_7dnumbernee; kan null zijn
reset_rate_limit_usagebooleannee; De bestedingen binnen de limietvensters resetten; kan null zijn
Objectvelden
{
  "name": "PLACEHOLDER_NAME (string)",
  "status": "PLACEHOLDER_STATUS (string)",
  "ip_whitelist": "PLACEHOLDER_IP_WHITELIST (array)",
  "ip_blacklist": "PLACEHOLDER_IP_BLACKLIST (array)",
  "quota": "PLACEHOLDER_QUOTA (number)",
  "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
  "reset_quota": "PLACEHOLDER_RESET_QUOTA (boolean)",
  "rate_limit_5h": "PLACEHOLDER_RATE_LIMIT_5H (number)",
  "rate_limit_1d": "PLACEHOLDER_RATE_LIMIT_1D (number)",
  "rate_limit_7d": "PLACEHOLDER_RATE_LIMIT_7D (number)",
  "reset_rate_limit_usage": "PLACEHOLDER_RESET_RATE_LIMIT_USAGE (boolean)"
}

UpdateProfileRequest

VeldTypeVerplichtValidatie / beschrijving
usernamestringnee; kan null zijn
avatar_urlstringnee; kan null zijn
balance_notify_enabledbooleannee; kan null zijn
balance_notify_thresholdnumbernee; kan null zijn
Objectvelden
{
  "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)"
}

UsageLog

VeldTypeVerplichtValidatie / beschrijving
idintegernee
user_idintegernee
api_key_idintegernee
request_idstringnee
modelstringnee
service_tierstringnee; kan null zijn
reasoning_effortstringnee; kan null zijn
input_tokensintegernee
output_tokensintegernee
cache_creation_tokensintegernee
cache_read_tokensintegernee
cache_creation_5m_tokensintegernee
cache_creation_1h_tokensintegernee
input_costnumbernee
output_costnumbernee
cache_creation_costnumbernee
cache_read_costnumbernee
total_costnumbernee
actual_costnumbernee
long_context_billing_appliedbooleannee
request_typestringnee
streambooleannee
duration_msintegernee; kan null zijn
first_token_msintegernee; kan null zijn
image_countintegernee
image_sizestringnee; kan null zijn
image_input_sizestringnee; kan null zijn
image_output_sizestringnee; kan null zijn
image_input_tokensintegernee
image_input_costnumbernee
image_output_tokensintegernee
image_output_costnumbernee
image_size_breakdownobject · additionalProperties: integernee
media_typestringnee; kan null zijn
ip_addressstringnee; kan null zijn
session_idstringnee; kan null zijn
created_atstringnee
userobject · Usernee; kan null zijn
api_keyobject · APIKeynee; kan null zijn
Objectvelden
{
  "id": "PLACEHOLDER_ID (integer)",
  "user_id": "PLACEHOLDER_USER_ID (integer)",
  "api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
  "request_id": "PLACEHOLDER_REQUEST_ID (string)",
  "model": "PLACEHOLDER_MODEL (string)",
  "service_tier": "PLACEHOLDER_SERVICE_TIER (string)",
  "reasoning_effort": "PLACEHOLDER_REASONING_EFFORT (string)",
  "input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
  "output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
  "cache_creation_tokens": "PLACEHOLDER_CACHE_CREATION_TOKENS (integer)",
  "cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
  "cache_creation_5m_tokens": "PLACEHOLDER_CACHE_CREATION_5M_TOKENS (integer)",
  "cache_creation_1h_tokens": "PLACEHOLDER_CACHE_CREATION_1H_TOKENS (integer)",
  "input_cost": "PLACEHOLDER_INPUT_COST (number)",
  "output_cost": "PLACEHOLDER_OUTPUT_COST (number)",
  "cache_creation_cost": "PLACEHOLDER_CACHE_CREATION_COST (number)",
  "cache_read_cost": "PLACEHOLDER_CACHE_READ_COST (number)",
  "total_cost": "PLACEHOLDER_TOTAL_COST (number)",
  "actual_cost": "PLACEHOLDER_ACTUAL_COST (number)",
  "long_context_billing_applied": "PLACEHOLDER_LONG_CONTEXT_BILLING_APPLIED (boolean)",
  "request_type": "PLACEHOLDER_REQUEST_TYPE (string)",
  "stream": "PLACEHOLDER_STREAM (boolean)",
  "duration_ms": "PLACEHOLDER_DURATION_MS (integer)",
  "first_token_ms": "PLACEHOLDER_FIRST_TOKEN_MS (integer)",
  "image_count": "PLACEHOLDER_IMAGE_COUNT (integer)",
  "image_size": "PLACEHOLDER_IMAGE_SIZE (string)",
  "image_input_size": "PLACEHOLDER_IMAGE_INPUT_SIZE (string)",
  "image_output_size": "PLACEHOLDER_IMAGE_OUTPUT_SIZE (string)",
  "image_input_tokens": "PLACEHOLDER_IMAGE_INPUT_TOKENS (integer)",
  "image_input_cost": "PLACEHOLDER_IMAGE_INPUT_COST (number)",
  "image_output_tokens": "PLACEHOLDER_IMAGE_OUTPUT_TOKENS (integer)",
  "image_output_cost": "PLACEHOLDER_IMAGE_OUTPUT_COST (number)",
  "image_size_breakdown": "PLACEHOLDER_IMAGE_SIZE_BREAKDOWN (object)",
  "media_type": "PLACEHOLDER_MEDIA_TYPE (string)",
  "ip_address": "PLACEHOLDER_IP_ADDRESS (string)",
  "session_id": "PLACEHOLDER_SESSION_ID (string)",
  "created_at": "PLACEHOLDER_CREATED_AT (string)",
  "user": "PLACEHOLDER_USER (object)",
  "api_key": "PLACEHOLDER_API_KEY (object)"
}

UsageStats

VeldTypeVerplichtValidatie / beschrijving
total_requestsintegernee
total_input_tokensintegernee
total_output_tokensintegernee
total_cache_tokensintegernee
total_cache_creation_tokensintegernee
total_cache_read_tokensintegernee
total_tokensintegernee
total_costnumbernee
total_actual_costnumbernee
average_duration_msnumbernee
endpointsarray · items: EndpointStat · EndpointStatnee
Objectvelden
{
  "total_requests": "PLACEHOLDER_TOTAL_REQUESTS (integer)",
  "total_input_tokens": "PLACEHOLDER_TOTAL_INPUT_TOKENS (integer)",
  "total_output_tokens": "PLACEHOLDER_TOTAL_OUTPUT_TOKENS (integer)",
  "total_cache_tokens": "PLACEHOLDER_TOTAL_CACHE_TOKENS (integer)",
  "total_cache_creation_tokens": "PLACEHOLDER_TOTAL_CACHE_CREATION_TOKENS (integer)",
  "total_cache_read_tokens": "PLACEHOLDER_TOTAL_CACHE_READ_TOKENS (integer)",
  "total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
  "total_cost": "PLACEHOLDER_TOTAL_COST (number)",
  "total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)",
  "average_duration_ms": "PLACEHOLDER_AVERAGE_DURATION_MS (number)",
  "endpoints": "PLACEHOLDER_ENDPOINTS (array)"
}

User

VeldTypeVerplichtValidatie / beschrijving
idintegernee
emailstringnee
usernamestringnee
rolestringnee
balancenumbernee
frozen_balancenumbernee
concurrencyintegernee
statusstringnee
last_active_atstringnee; kan null zijn
created_atstringnee
updated_atstringnee
deleted_atstringnee; kan null zijn
balance_notify_enabledbooleannee
balance_notify_threshold_typestringnee
balance_notify_thresholdnumbernee; kan null zijn
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynee
total_rechargednumbernee
rpm_limitintegernee
api_keysarray · items: APIKey · APIKeynee
Objectvelden
{
  "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)"
}

UserAnnouncement

VeldTypeVerplichtValidatie / beschrijving
idintegernee
titlestringnee
contentstringnee
notify_modestringnee
starts_atstringnee; kan null zijn
ends_atstringnee; kan null zijn
read_atstringnee; kan null zijn
created_atstringnee
updated_atstringnee
Objectvelden
{
  "id": "PLACEHOLDER_ID (integer)",
  "title": "PLACEHOLDER_TITLE (string)",
  "content": "PLACEHOLDER_CONTENT (string)",
  "notify_mode": "PLACEHOLDER_NOTIFY_MODE (string)",
  "starts_at": "PLACEHOLDER_STARTS_AT (string)",
  "ends_at": "PLACEHOLDER_ENDS_AT (string)",
  "read_at": "PLACEHOLDER_READ_AT (string)",
  "created_at": "PLACEHOLDER_CREATED_AT (string)",
  "updated_at": "PLACEHOLDER_UPDATED_AT (string)"
}

UserDashboardStats

VeldTypeVerplichtValidatie / beschrijving
total_api_keysintegernee
active_api_keysintegernee
total_requestsintegernee
total_input_tokensintegernee
total_output_tokensintegernee
total_cache_creation_tokensintegernee
total_cache_read_tokensintegernee
total_tokensintegernee
total_costnumbernee; Totale kosten tegen de standaardprijs
total_actual_costnumbernee; Totaal daadwerkelijk afgeschreven bedrag
today_requestsintegernee
today_input_tokensintegernee
today_output_tokensintegernee
today_cache_creation_tokensintegernee
today_cache_read_tokensintegernee
today_tokensintegernee
today_costnumbernee; Kosten van vandaag tegen de standaardprijs
today_actual_costnumbernee; Daadwerkelijk afgeschreven bedrag vandaag
average_duration_msnumbernee
rpmintegernee; Gemiddeld aantal verzoeken per minuut in de afgelopen 5 minuten
tpmintegernee; Gemiddeld aantal tokens per minuut in de afgelopen 5 minuten
Objectvelden
{
  "total_api_keys": "PLACEHOLDER_TOTAL_API_KEYS (integer)",
  "active_api_keys": "PLACEHOLDER_ACTIVE_API_KEYS (integer)",
  "total_requests": "PLACEHOLDER_TOTAL_REQUESTS (integer)",
  "total_input_tokens": "PLACEHOLDER_TOTAL_INPUT_TOKENS (integer)",
  "total_output_tokens": "PLACEHOLDER_TOTAL_OUTPUT_TOKENS (integer)",
  "total_cache_creation_tokens": "PLACEHOLDER_TOTAL_CACHE_CREATION_TOKENS (integer)",
  "total_cache_read_tokens": "PLACEHOLDER_TOTAL_CACHE_READ_TOKENS (integer)",
  "total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
  "total_cost": "PLACEHOLDER_TOTAL_COST (number)",
  "total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)",
  "today_requests": "PLACEHOLDER_TODAY_REQUESTS (integer)",
  "today_input_tokens": "PLACEHOLDER_TODAY_INPUT_TOKENS (integer)",
  "today_output_tokens": "PLACEHOLDER_TODAY_OUTPUT_TOKENS (integer)",
  "today_cache_creation_tokens": "PLACEHOLDER_TODAY_CACHE_CREATION_TOKENS (integer)",
  "today_cache_read_tokens": "PLACEHOLDER_TODAY_CACHE_READ_TOKENS (integer)",
  "today_tokens": "PLACEHOLDER_TODAY_TOKENS (integer)",
  "today_cost": "PLACEHOLDER_TODAY_COST (number)",
  "today_actual_cost": "PLACEHOLDER_TODAY_ACTUAL_COST (number)",
  "average_duration_ms": "PLACEHOLDER_AVERAGE_DURATION_MS (number)",
  "rpm": "PLACEHOLDER_RPM (integer)",
  "tpm": "PLACEHOLDER_TPM (integer)"
}

UserProfileResponse

VeldTypeVerplichtValidatie / beschrijving
idintegernee
emailstringnee
usernamestringnee
rolestringnee
balancenumbernee
frozen_balancenumbernee
concurrencyintegernee
statusstringnee
last_active_atstringnee; kan null zijn
created_atstringnee
updated_atstringnee
deleted_atstringnee; kan null zijn
balance_notify_enabledbooleannee
balance_notify_threshold_typestringnee
balance_notify_thresholdnumbernee; kan null zijn
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynee
total_rechargednumbernee
rpm_limitintegernee
api_keysarray · items: APIKey · APIKeynee
avatar_urlstringnee
email_boundbooleannee
Objectvelden
{
  "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)"
}

ValidateInvitationCodeRequest

VeldTypeVerplichtValidatie / beschrijving
codestringjarequired
Objectvelden
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

VeldTypeVerplichtValidatie / beschrijving
validbooleannee
error_codestringnee
Objectvelden
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

VeldTypeVerplichtValidatie / beschrijving
codestringjarequired
Objectvelden
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

VeldTypeVerplichtValidatie / beschrijving
validbooleannee
bonus_amountnumbernee
error_codestringnee
messagestringnee
Objectvelden
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "bonus_amount": "PLACEHOLDER_BONUS_AMOUNT (number)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)",
  "message": "PLACEHOLDER_MESSAGE (string)"
}

NotifyEmailEntry

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "disabled": {
      "type": "boolean"
    },
    "verified": {
      "type": "boolean"
    }
  }
}

EndpointStat

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string"
    },
    "requests": {
      "type": "integer"
    },
    "total_tokens": {
      "type": "integer"
    },
    "cost": {
      "type": "number"
    },
    "actual_cost": {
      "type": "number"
    }
  }
}
Nog vragen? Stuur de Request ID en een beschrijving — we helpen je verder.Contact opnemen met support
InloggenRegistrerenDashboard
Tarieven