dokumentation
Kontrollpanel
Kontrollpanelens API

Datascheman

Markdown

Fält och objekttyper i kontrollpanelens API.

Fullständig guide

Objektfält och typer i kontrollpanelens API. omitempty betyder att fältet kan saknas i svaret; det tillåter inte att null skickas. PLACEHOLDER-strängar anger typen, inte ett faktiskt svar.

APIKey

FältetTypObligatorisktValidering / beskrivning
idintegernej
user_idintegernej
keystringnej
namestringnej
statusstringnej
ip_whitelistarray · items: stringnej
ip_blacklistarray · items: stringnej
last_used_atstringnej; kan vara null
last_used_ipstringnej; kan vara null
quotanumbernej; Nyckelns utgiftsgräns i USD; 0 — ingen gräns
quota_usednumbernej; Förbrukat av nyckelns gräns, USD
expires_atstringnej; Giltighetstid; null — utan utgångstid; kan vara null
created_atstringnej
updated_atstringnej
current_concurrencyintegernej
rate_limit_5hnumbernej
rate_limit_1dnumbernej
rate_limit_7dnumbernej
usage_5hnumbernej
usage_1dnumbernej
usage_7dnumbernej
window_5h_startstringnej; kan vara null
window_1d_startstringnej; kan vara null
window_7d_startstringnej; kan vara null
reset_5h_atstringnej; kan vara null
reset_1d_atstringnej; kan vara null
reset_7d_atstringnej; kan vara null
userobject · Usernej; kan vara null
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
datestringnej
requestsintegernej
input_tokensintegernej
output_tokensintegernej
cache_read_tokensintegernej
cache_write_tokensintegernej
total_tokensintegernej
costnumbernej; Kostnad till standardpris
actual_costnumbernej; Faktisk debitering
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
access_tokenstringnej
refresh_tokenstringnej; Uppdateringstoken för sessionen
expires_inintegernej; Åtkomsttokens giltighetstid i sekunder
token_typestringnej
userobject · Usernej; kan vara null
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
api_key_idsarray · items: integer (int64)jarequired
Objektfält
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

FältetTypObligatorisktValidering / beskrivning
api_key_idintegernej
today_actual_costnumbernej
total_actual_costnumbernej
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
old_passwordstringjarequired
new_passwordstringjarequired,min=6
Objektfält
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

FältetTypObligatorisktValidering / beskrivning
namestringjarequired
custom_keystringnej; Valfritt eget nyckelvärde; kan vara null
ip_whitelistarray · items: stringnej; Lista över tillåtna IP-adresser
ip_blacklistarray · items: stringnej; Lista över blockerade IP-adresser
quotanumbernej; Nyckelns utgiftsgräns i USD; kan vara null
expires_in_daysintegernej; Giltighetstid i dagar; kan vara null
rate_limit_5hnumbernej; kan vara null
rate_limit_1dnumbernej; kan vara null
rate_limit_7dnumbernej; kan vara null
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
emailstringjarequired,email
turnstile_tokenstringnej
Objektfält
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

FältetTypObligatorisktValidering / beskrivning
messagestringnej
Objektfält
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

FältetTypObligatorisktValidering / beskrivning
temp_tokenstringjarequired
totp_codestringjarequired,len=6
Objektfält
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

FältetTypObligatorisktValidering / beskrivning
emailstringjarequired,email
passwordstringjarequired
turnstile_tokenstringnej
Objektfält
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

FältetTypObligatorisktValidering / beskrivning
refresh_tokenstringnej; Valfritt: återkalla angiven uppdateringstoken
Objektfält
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

FältetTypObligatorisktValidering / beskrivning
messagestringnej
Objektfält
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

FältetTypObligatorisktValidering / beskrivning
turnstile_tokenstringnej
Objektfält
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

FältetTypObligatorisktValidering / beskrivning
idintegernej
namestringnej
created_atstringnej
last_used_atstringnej; kan vara null
backupbooleannej
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
session_tokenstringjarequired
namestringnej
credentialobject · WebAuthn PublicKeyCredential JSONjarequired
Objektfält
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

FältetTypObligatorisktValidering / beskrivning
session_tokenstringnej
optionsanynej
Objektfält
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

FältetTypObligatorisktValidering / beskrivning
idintegernej
codestringnej
typestringnej
valuenumbernej
statusstringnej
used_byintegernej; kan vara null
used_atstringnej; kan vara null
created_atstringnej
expires_atstringnej; kan vara null
validity_daysintegernej
notesstringnej; kan vara null
userobject · Usernej; kan vara null
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
codestringjarequired
Objektfält
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

FältetTypObligatorisktValidering / beskrivning
refresh_tokenstringjarequired
Objektfält
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

FältetTypObligatorisktValidering / beskrivning
access_tokenstringnej
refresh_tokenstringnej
expires_inintegernej; Åtkomsttokens giltighetstid i sekunder
token_typestringnej
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
emailstringjarequired,email
passwordstringjarequired,min=6
verify_codestringnej
turnstile_tokenstringnej
promo_codestringnej; Kampanjkod för registrering
invitation_codestringnej; Inbjudningskod
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
emailstringjarequired,email
tokenstringjarequired
new_passwordstringjarequired,min=6
Objektfält
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

FältetTypObligatorisktValidering / beskrivning
messagestringnej
Objektfält
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

FältetTypObligatorisktValidering / beskrivning
messagestringnej
Objektfält
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

FältetTypObligatorisktValidering / beskrivning
emailstringjarequired,email
turnstile_tokenstringnej
Objektfält
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

FältetTypObligatorisktValidering / beskrivning
messagestringnej
countdownintegernej; Väntetid i sekunder
Objektfält
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

FältetTypObligatorisktValidering / beskrivning
requires_2fabooleannej
temp_tokenstringnej
user_email_maskedstringnej
Objektfält
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

FältetTypObligatorisktValidering / beskrivning
enabledbooleannej
enabled_atintegernej; Unix-tidsstämpel; kan vara null
feature_enabledbooleannej
Objektfält
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

FältetTypObligatorisktValidering / beskrivning
namestringnej
statusstringnejomitempty,oneof=active inactive
ip_whitelistarray · items: stringnej; Tillåtna IP-adresser: null lämnar listan oförändrad, en tom array tömmer den; kan vara null
ip_blacklistarray · items: stringnej; Blockerade IP-adresser: null lämnar listan oförändrad, en tom array tömmer den; kan vara null
quotanumbernej; Nyckelns utgiftsgräns i USD; 0 — ingen gräns; kan vara null
expires_atstringnej; Utgångstid i ISO 8601-format; kan vara null
reset_quotabooleannej; Nollställ den förbrukade delen av utgiftsgränsen; kan vara null
rate_limit_5hnumbernej; kan vara null
rate_limit_1dnumbernej; kan vara null
rate_limit_7dnumbernej; kan vara null
reset_rate_limit_usagebooleannej; Nollställ förbrukningen för tidsfönstrens gränser; kan vara null
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
usernamestringnej; kan vara null
avatar_urlstringnej; kan vara null
balance_notify_enabledbooleannej; kan vara null
balance_notify_thresholdnumbernej; kan vara null
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
idintegernej
user_idintegernej
api_key_idintegernej
request_idstringnej
modelstringnej
service_tierstringnej; kan vara null
reasoning_effortstringnej; kan vara null
input_tokensintegernej
output_tokensintegernej
cache_creation_tokensintegernej
cache_read_tokensintegernej
cache_creation_5m_tokensintegernej
cache_creation_1h_tokensintegernej
input_costnumbernej
output_costnumbernej
cache_creation_costnumbernej
cache_read_costnumbernej
total_costnumbernej
actual_costnumbernej
long_context_billing_appliedbooleannej
request_typestringnej
streambooleannej
duration_msintegernej; kan vara null
first_token_msintegernej; kan vara null
image_countintegernej
image_sizestringnej; kan vara null
image_input_sizestringnej; kan vara null
image_output_sizestringnej; kan vara null
image_input_tokensintegernej
image_input_costnumbernej
image_output_tokensintegernej
image_output_costnumbernej
image_size_breakdownobject · additionalProperties: integernej
media_typestringnej; kan vara null
ip_addressstringnej; kan vara null
session_idstringnej; kan vara null
created_atstringnej
userobject · Usernej; kan vara null
api_keyobject · APIKeynej; kan vara null
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
total_requestsintegernej
total_input_tokensintegernej
total_output_tokensintegernej
total_cache_tokensintegernej
total_cache_creation_tokensintegernej
total_cache_read_tokensintegernej
total_tokensintegernej
total_costnumbernej
total_actual_costnumbernej
average_duration_msnumbernej
endpointsarray · items: EndpointStat · EndpointStatnej
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
idintegernej
emailstringnej
usernamestringnej
rolestringnej
balancenumbernej
frozen_balancenumbernej
concurrencyintegernej
statusstringnej
last_active_atstringnej; kan vara null
created_atstringnej
updated_atstringnej
deleted_atstringnej; kan vara null
balance_notify_enabledbooleannej
balance_notify_threshold_typestringnej
balance_notify_thresholdnumbernej; kan vara null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynej
total_rechargednumbernej
rpm_limitintegernej
api_keysarray · items: APIKey · APIKeynej
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
idintegernej
titlestringnej
contentstringnej
notify_modestringnej
starts_atstringnej; kan vara null
ends_atstringnej; kan vara null
read_atstringnej; kan vara null
created_atstringnej
updated_atstringnej
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
total_api_keysintegernej
active_api_keysintegernej
total_requestsintegernej
total_input_tokensintegernej
total_output_tokensintegernej
total_cache_creation_tokensintegernej
total_cache_read_tokensintegernej
total_tokensintegernej
total_costnumbernej; Total kostnad till standardpris
total_actual_costnumbernej; Total faktisk debitering
today_requestsintegernej
today_input_tokensintegernej
today_output_tokensintegernej
today_cache_creation_tokensintegernej
today_cache_read_tokensintegernej
today_tokensintegernej
today_costnumbernej; Dagens kostnad till standardpris
today_actual_costnumbernej; Faktisk debitering i dag
average_duration_msnumbernej
rpmintegernej; Genomsnittligt antal anrop per minut under de senaste 5 minuterna
tpmintegernej; Genomsnittligt antal token per minut under de senaste 5 minuterna
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
idintegernej
emailstringnej
usernamestringnej
rolestringnej
balancenumbernej
frozen_balancenumbernej
concurrencyintegernej
statusstringnej
last_active_atstringnej; kan vara null
created_atstringnej
updated_atstringnej
deleted_atstringnej; kan vara null
balance_notify_enabledbooleannej
balance_notify_threshold_typestringnej
balance_notify_thresholdnumbernej; kan vara null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynej
total_rechargednumbernej
rpm_limitintegernej
api_keysarray · items: APIKey · APIKeynej
avatar_urlstringnej
email_boundbooleannej
Objektfält
{
  "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

FältetTypObligatorisktValidering / beskrivning
codestringjarequired
Objektfält
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

FältetTypObligatorisktValidering / beskrivning
validbooleannej
error_codestringnej
Objektfält
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

FältetTypObligatorisktValidering / beskrivning
codestringjarequired
Objektfält
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

FältetTypObligatorisktValidering / beskrivning
validbooleannej
bonus_amountnumbernej
error_codestringnej
messagestringnej
Objektfält
{
  "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"
    }
  }
}
Har du fler frågor? Skicka Request ID och en beskrivning, så hjälper vi dig.Kontakta supporten
Logga inRegistrera digKontrollpanel
Priser