Doku
Kundenbereich
API des Kundenbereichs

Datenschemata

Markdown

Felder und Typen der Objekte der Kundenbereich-API.

Vollständiger Leitfaden

Objektfelder der Kundenbereich-API und deren Typen. omitempty bedeutet, dass das Feld in der Antwort fehlen kann; es erlaubt nicht, null zu senden. PLACEHOLDER-Strings bezeichnen den Typ, keine echte Antwort.

APIKey

Das FeldTypErforderlichValidierung / Beschreibung
idintegernein
user_idintegernein
keystringnein
namestringnein
statusstringnein
ip_whitelistarray · items: stringnein
ip_blacklistarray · items: stringnein
last_used_atstringnein; kann null sein
last_used_ipstringnein; kann null sein
quotanumbernein; Ausgabenlimit des Schlüssels in USD; 0 — ohne Limit
quota_usednumbernein; Verbrauchter Anteil des Schlüssellimits, USD
expires_atstringnein; Gültigkeitsdauer; null — unbefristet; kann null sein
created_atstringnein
updated_atstringnein
current_concurrencyintegernein
rate_limit_5hnumbernein
rate_limit_1dnumbernein
rate_limit_7dnumbernein
usage_5hnumbernein
usage_1dnumbernein
usage_7dnumbernein
window_5h_startstringnein; kann null sein
window_1d_startstringnein; kann null sein
window_7d_startstringnein; kann null sein
reset_5h_atstringnein; kann null sein
reset_1d_atstringnein; kann null sein
reset_7d_atstringnein; kann null sein
userobject · Usernein; kann null sein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
datestringnein
requestsintegernein
input_tokensintegernein
output_tokensintegernein
cache_read_tokensintegernein
cache_write_tokensintegernein
total_tokensintegernein
costnumbernein; Kosten zum Standardpreis
actual_costnumbernein; Tatsächliche Abbuchung
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
access_tokenstringnein
refresh_tokenstringnein; Refresh-Token der Sitzung
expires_inintegernein; Gültigkeitsdauer des Zugriffstokens in Sekunden
token_typestringnein
userobject · Usernein; kann null sein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
api_key_idsarray · items: integer (int64)jarequired
Objektfelder
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

Das FeldTypErforderlichValidierung / Beschreibung
api_key_idintegernein
today_actual_costnumbernein
total_actual_costnumbernein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
old_passwordstringjarequired
new_passwordstringjarequired,min=6
Objektfelder
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

Das FeldTypErforderlichValidierung / Beschreibung
namestringjarequired
custom_keystringnein; Optionaler eigener Schlüsselwert; kann null sein
ip_whitelistarray · items: stringnein; Liste erlaubter IP-Adressen
ip_blacklistarray · items: stringnein; Liste gesperrter IP-Adressen
quotanumbernein; Ausgabenlimit des Schlüssels in USD; kann null sein
expires_in_daysintegernein; Gültigkeitsdauer in Tagen; kann null sein
rate_limit_5hnumbernein; kann null sein
rate_limit_1dnumbernein; kann null sein
rate_limit_7dnumbernein; kann null sein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
emailstringjarequired,email
turnstile_tokenstringnein
Objektfelder
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

Das FeldTypErforderlichValidierung / Beschreibung
messagestringnein
Objektfelder
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

Das FeldTypErforderlichValidierung / Beschreibung
temp_tokenstringjarequired
totp_codestringjarequired,len=6
Objektfelder
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

Das FeldTypErforderlichValidierung / Beschreibung
emailstringjarequired,email
passwordstringjarequired
turnstile_tokenstringnein
Objektfelder
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

Das FeldTypErforderlichValidierung / Beschreibung
refresh_tokenstringnein; Optional: angegebenes Refresh-Token widerrufen
Objektfelder
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

Das FeldTypErforderlichValidierung / Beschreibung
messagestringnein
Objektfelder
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

Das FeldTypErforderlichValidierung / Beschreibung
turnstile_tokenstringnein
Objektfelder
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

Das FeldTypErforderlichValidierung / Beschreibung
idintegernein
namestringnein
created_atstringnein
last_used_atstringnein; kann null sein
backupbooleannein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
session_tokenstringjarequired
namestringnein
credentialobject · WebAuthn PublicKeyCredential JSONjarequired
Objektfelder
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

Das FeldTypErforderlichValidierung / Beschreibung
session_tokenstringnein
optionsanynein
Objektfelder
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

Das FeldTypErforderlichValidierung / Beschreibung
idintegernein
codestringnein
typestringnein
valuenumbernein
statusstringnein
used_byintegernein; kann null sein
used_atstringnein; kann null sein
created_atstringnein
expires_atstringnein; kann null sein
validity_daysintegernein
notesstringnein; kann null sein
userobject · Usernein; kann null sein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
codestringjarequired
Objektfelder
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

Das FeldTypErforderlichValidierung / Beschreibung
refresh_tokenstringjarequired
Objektfelder
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

Das FeldTypErforderlichValidierung / Beschreibung
access_tokenstringnein
refresh_tokenstringnein
expires_inintegernein; Gültigkeitsdauer des Zugriffstokens in Sekunden
token_typestringnein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
emailstringjarequired,email
passwordstringjarequired,min=6
verify_codestringnein
turnstile_tokenstringnein
promo_codestringnein; Aktionscode für die Registrierung
invitation_codestringnein; Einladungscode
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
emailstringjarequired,email
tokenstringjarequired
new_passwordstringjarequired,min=6
Objektfelder
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

Das FeldTypErforderlichValidierung / Beschreibung
messagestringnein
Objektfelder
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

Das FeldTypErforderlichValidierung / Beschreibung
messagestringnein
Objektfelder
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

Das FeldTypErforderlichValidierung / Beschreibung
emailstringjarequired,email
turnstile_tokenstringnein
Objektfelder
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

Das FeldTypErforderlichValidierung / Beschreibung
messagestringnein
countdownintegernein; Wartezeit in Sekunden
Objektfelder
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

Das FeldTypErforderlichValidierung / Beschreibung
requires_2fabooleannein
temp_tokenstringnein
user_email_maskedstringnein
Objektfelder
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

Das FeldTypErforderlichValidierung / Beschreibung
enabledbooleannein
enabled_atintegernein; Unix timestamp; kann null sein
feature_enabledbooleannein
Objektfelder
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

Das FeldTypErforderlichValidierung / Beschreibung
namestringnein
statusstringneinomitempty,oneof=active inactive
ip_whitelistarray · items: stringnein; Erlaubte IP-Adressen: null lässt die Liste unverändert, ein leeres Array leert sie; kann null sein
ip_blacklistarray · items: stringnein; Gesperrte IP-Adressen: null lässt die Liste unverändert, ein leeres Array leert sie; kann null sein
quotanumbernein; Ausgabenlimit des Schlüssels in USD; 0 — ohne Limit; kann null sein
expires_atstringnein; Ablaufzeitpunkt im Format ISO 8601; kann null sein
reset_quotabooleannein; Verbrauchten Anteil des Ausgabenlimits zurücksetzen; kann null sein
rate_limit_5hnumbernein; kann null sein
rate_limit_1dnumbernein; kann null sein
rate_limit_7dnumbernein; kann null sein
reset_rate_limit_usagebooleannein; Verbrauch der Zeitfensterlimits zurücksetzen; kann null sein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
usernamestringnein; kann null sein
avatar_urlstringnein; kann null sein
balance_notify_enabledbooleannein; kann null sein
balance_notify_thresholdnumbernein; kann null sein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
idintegernein
user_idintegernein
api_key_idintegernein
request_idstringnein
modelstringnein
service_tierstringnein; kann null sein
reasoning_effortstringnein; kann null sein
input_tokensintegernein
output_tokensintegernein
cache_creation_tokensintegernein
cache_read_tokensintegernein
cache_creation_5m_tokensintegernein
cache_creation_1h_tokensintegernein
input_costnumbernein
output_costnumbernein
cache_creation_costnumbernein
cache_read_costnumbernein
total_costnumbernein
actual_costnumbernein
long_context_billing_appliedbooleannein
request_typestringnein
streambooleannein
duration_msintegernein; kann null sein
first_token_msintegernein; kann null sein
image_countintegernein
image_sizestringnein; kann null sein
image_input_sizestringnein; kann null sein
image_output_sizestringnein; kann null sein
image_input_tokensintegernein
image_input_costnumbernein
image_output_tokensintegernein
image_output_costnumbernein
image_size_breakdownobject · additionalProperties: integernein
media_typestringnein; kann null sein
ip_addressstringnein; kann null sein
session_idstringnein; kann null sein
created_atstringnein
userobject · Usernein; kann null sein
api_keyobject · APIKeynein; kann null sein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
total_requestsintegernein
total_input_tokensintegernein
total_output_tokensintegernein
total_cache_tokensintegernein
total_cache_creation_tokensintegernein
total_cache_read_tokensintegernein
total_tokensintegernein
total_costnumbernein
total_actual_costnumbernein
average_duration_msnumbernein
endpointsarray · items: EndpointStat · EndpointStatnein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
idintegernein
emailstringnein
usernamestringnein
rolestringnein
balancenumbernein
frozen_balancenumbernein
concurrencyintegernein
statusstringnein
last_active_atstringnein; kann null sein
created_atstringnein
updated_atstringnein
deleted_atstringnein; kann null sein
balance_notify_enabledbooleannein
balance_notify_threshold_typestringnein
balance_notify_thresholdnumbernein; kann null sein
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynein
total_rechargednumbernein
rpm_limitintegernein
api_keysarray · items: APIKey · APIKeynein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
idintegernein
titlestringnein
contentstringnein
notify_modestringnein
starts_atstringnein; kann null sein
ends_atstringnein; kann null sein
read_atstringnein; kann null sein
created_atstringnein
updated_atstringnein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
total_api_keysintegernein
active_api_keysintegernein
total_requestsintegernein
total_input_tokensintegernein
total_output_tokensintegernein
total_cache_creation_tokensintegernein
total_cache_read_tokensintegernein
total_tokensintegernein
total_costnumbernein; Gesamtkosten zum Standardpreis
total_actual_costnumbernein; Tatsächliche Abbuchung insgesamt
today_requestsintegernein
today_input_tokensintegernein
today_output_tokensintegernein
today_cache_creation_tokensintegernein
today_cache_read_tokensintegernein
today_tokensintegernein
today_costnumbernein; Heutige Kosten zum Standardpreis
today_actual_costnumbernein; Tatsächliche Abbuchung heute
average_duration_msnumbernein
rpmintegernein; Durchschnittliche Requests pro Minute in den letzten 5 Minuten
tpmintegernein; Durchschnittliche Tokens pro Minute in den letzten 5 Minuten
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
idintegernein
emailstringnein
usernamestringnein
rolestringnein
balancenumbernein
frozen_balancenumbernein
concurrencyintegernein
statusstringnein
last_active_atstringnein; kann null sein
created_atstringnein
updated_atstringnein
deleted_atstringnein; kann null sein
balance_notify_enabledbooleannein
balance_notify_threshold_typestringnein
balance_notify_thresholdnumbernein; kann null sein
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynein
total_rechargednumbernein
rpm_limitintegernein
api_keysarray · items: APIKey · APIKeynein
avatar_urlstringnein
email_boundbooleannein
Objektfelder
{
  "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

Das FeldTypErforderlichValidierung / Beschreibung
codestringjarequired
Objektfelder
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

Das FeldTypErforderlichValidierung / Beschreibung
validbooleannein
error_codestringnein
Objektfelder
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

Das FeldTypErforderlichValidierung / Beschreibung
codestringjarequired
Objektfelder
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

Das FeldTypErforderlichValidierung / Beschreibung
validbooleannein
bonus_amountnumbernein
error_codestringnein
messagestringnein
Objektfelder
{
  "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"
    }
  }
}
Noch Fragen? Senden Sie uns die Request ID und eine Beschreibung — wir helfen Ihnen weiter.Support kontaktieren
AnmeldenRegistrierenKundenbereich
Tarife