dokumentasjon
Kontrollpanel
API for kontrollpanelet

Dataskjemaer

Markdown

Felter og objekttyper for kontrollpanel-API-et.

Fullstendig guide

Objektfelter og typer for kontrollpanel-API-et. omitempty betyr at feltet kan mangle i svaret; det gir ikke tillatelse til å sende null. PLACEHOLDER-strenger angir typen, ikke et faktisk svar.

APIKey

FeltetTypePåkrevdValidering / beskrivelse
idintegernei
user_idintegernei
keystringnei
namestringnei
statusstringnei
ip_whitelistarray · items: stringnei
ip_blacklistarray · items: stringnei
last_used_atstringnei; kan være null
last_used_ipstringnei; kan være null
quotanumbernei; Nøkkelens forbruksgrense i USD; 0 — ingen grense
quota_usednumbernei; Brukt av nøkkelens grense, USD
expires_atstringnei; Gyldighetstid; null — uten utløp; kan være null
created_atstringnei
updated_atstringnei
current_concurrencyintegernei
rate_limit_5hnumbernei
rate_limit_1dnumbernei
rate_limit_7dnumbernei
usage_5hnumbernei
usage_1dnumbernei
usage_7dnumbernei
window_5h_startstringnei; kan være null
window_1d_startstringnei; kan være null
window_7d_startstringnei; kan være null
reset_5h_atstringnei; kan være null
reset_1d_atstringnei; kan være null
reset_7d_atstringnei; kan være null
userobject · Usernei; kan være null
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
datestringnei
requestsintegernei
input_tokensintegernei
output_tokensintegernei
cache_read_tokensintegernei
cache_write_tokensintegernei
total_tokensintegernei
costnumbernei; Kostnad til standardpris
actual_costnumbernei; Faktisk belastning
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
access_tokenstringnei
refresh_tokenstringnei; Oppdateringstoken for økten
expires_inintegernei; Tilgangstokenets gyldighetstid i sekunder
token_typestringnei
userobject · Usernei; kan være null
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
api_key_idsarray · items: integer (int64)jarequired
Objektfelter
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

FeltetTypePåkrevdValidering / beskrivelse
api_key_idintegernei
today_actual_costnumbernei
total_actual_costnumbernei
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
old_passwordstringjarequired
new_passwordstringjarequired,min=6
Objektfelter
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

FeltetTypePåkrevdValidering / beskrivelse
namestringjarequired
custom_keystringnei; Valgfri egendefinert nøkkelverdi; kan være null
ip_whitelistarray · items: stringnei; Liste over tillatte IP-er
ip_blacklistarray · items: stringnei; Liste over blokkerte IP-er
quotanumbernei; Nøkkelens forbruksgrense i USD; kan være null
expires_in_daysintegernei; Gyldighetstid i dager; kan være null
rate_limit_5hnumbernei; kan være null
rate_limit_1dnumbernei; kan være null
rate_limit_7dnumbernei; kan være null
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
emailstringjarequired,email
turnstile_tokenstringnei
Objektfelter
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

FeltetTypePåkrevdValidering / beskrivelse
messagestringnei
Objektfelter
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

FeltetTypePåkrevdValidering / beskrivelse
temp_tokenstringjarequired
totp_codestringjarequired,len=6
Objektfelter
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

FeltetTypePåkrevdValidering / beskrivelse
emailstringjarequired,email
passwordstringjarequired
turnstile_tokenstringnei
Objektfelter
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

FeltetTypePåkrevdValidering / beskrivelse
refresh_tokenstringnei; Valgfritt: tilbakekall det angitte oppdateringstokenet
Objektfelter
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

FeltetTypePåkrevdValidering / beskrivelse
messagestringnei
Objektfelter
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

FeltetTypePåkrevdValidering / beskrivelse
turnstile_tokenstringnei
Objektfelter
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

FeltetTypePåkrevdValidering / beskrivelse
idintegernei
namestringnei
created_atstringnei
last_used_atstringnei; kan være null
backupbooleannei
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
session_tokenstringjarequired
namestringnei
credentialobject · WebAuthn PublicKeyCredential JSONjarequired
Objektfelter
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

FeltetTypePåkrevdValidering / beskrivelse
session_tokenstringnei
optionsanynei
Objektfelter
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

FeltetTypePåkrevdValidering / beskrivelse
idintegernei
codestringnei
typestringnei
valuenumbernei
statusstringnei
used_byintegernei; kan være null
used_atstringnei; kan være null
created_atstringnei
expires_atstringnei; kan være null
validity_daysintegernei
notesstringnei; kan være null
userobject · Usernei; kan være null
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
codestringjarequired
Objektfelter
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

FeltetTypePåkrevdValidering / beskrivelse
refresh_tokenstringjarequired
Objektfelter
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

FeltetTypePåkrevdValidering / beskrivelse
access_tokenstringnei
refresh_tokenstringnei
expires_inintegernei; Tilgangstokenets gyldighetstid i sekunder
token_typestringnei
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
emailstringjarequired,email
passwordstringjarequired,min=6
verify_codestringnei
turnstile_tokenstringnei
promo_codestringnei; Kampanjekode ved registrering
invitation_codestringnei; Invitasjonskode
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
emailstringjarequired,email
tokenstringjarequired
new_passwordstringjarequired,min=6
Objektfelter
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

FeltetTypePåkrevdValidering / beskrivelse
messagestringnei
Objektfelter
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

FeltetTypePåkrevdValidering / beskrivelse
messagestringnei
Objektfelter
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

FeltetTypePåkrevdValidering / beskrivelse
emailstringjarequired,email
turnstile_tokenstringnei
Objektfelter
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

FeltetTypePåkrevdValidering / beskrivelse
messagestringnei
countdownintegernei; Ventetid i sekunder
Objektfelter
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

FeltetTypePåkrevdValidering / beskrivelse
requires_2fabooleannei
temp_tokenstringnei
user_email_maskedstringnei
Objektfelter
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

FeltetTypePåkrevdValidering / beskrivelse
enabledbooleannei
enabled_atintegernei; Unix-tidsstempel; kan være null
feature_enabledbooleannei
Objektfelter
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

FeltetTypePåkrevdValidering / beskrivelse
namestringnei
statusstringneiomitempty,oneof=active inactive
ip_whitelistarray · items: stringnei; Tillatte IP-er: null lar listen være uendret, en tom liste tømmer den; kan være null
ip_blacklistarray · items: stringnei; Blokkerte IP-er: null lar listen være uendret, en tom liste tømmer den; kan være null
quotanumbernei; Nøkkelens forbruksgrense i USD; 0 — ingen grense; kan være null
expires_atstringnei; Utløpstidspunkt i ISO 8601-format; kan være null
reset_quotabooleannei; Nullstill beløpet som er brukt av forbruksgrensen; kan være null
rate_limit_5hnumbernei; kan være null
rate_limit_1dnumbernei; kan være null
rate_limit_7dnumbernei; kan være null
reset_rate_limit_usagebooleannei; Nullstill forbruket for tidsvinduene; kan være null
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
usernamestringnei; kan være null
avatar_urlstringnei; kan være null
balance_notify_enabledbooleannei; kan være null
balance_notify_thresholdnumbernei; kan være null
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
idintegernei
user_idintegernei
api_key_idintegernei
request_idstringnei
modelstringnei
service_tierstringnei; kan være null
reasoning_effortstringnei; kan være null
input_tokensintegernei
output_tokensintegernei
cache_creation_tokensintegernei
cache_read_tokensintegernei
cache_creation_5m_tokensintegernei
cache_creation_1h_tokensintegernei
input_costnumbernei
output_costnumbernei
cache_creation_costnumbernei
cache_read_costnumbernei
total_costnumbernei
actual_costnumbernei
long_context_billing_appliedbooleannei
request_typestringnei
streambooleannei
duration_msintegernei; kan være null
first_token_msintegernei; kan være null
image_countintegernei
image_sizestringnei; kan være null
image_input_sizestringnei; kan være null
image_output_sizestringnei; kan være null
image_input_tokensintegernei
image_input_costnumbernei
image_output_tokensintegernei
image_output_costnumbernei
image_size_breakdownobject · additionalProperties: integernei
media_typestringnei; kan være null
ip_addressstringnei; kan være null
session_idstringnei; kan være null
created_atstringnei
userobject · Usernei; kan være null
api_keyobject · APIKeynei; kan være null
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
total_requestsintegernei
total_input_tokensintegernei
total_output_tokensintegernei
total_cache_tokensintegernei
total_cache_creation_tokensintegernei
total_cache_read_tokensintegernei
total_tokensintegernei
total_costnumbernei
total_actual_costnumbernei
average_duration_msnumbernei
endpointsarray · items: EndpointStat · EndpointStatnei
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
idintegernei
emailstringnei
usernamestringnei
rolestringnei
balancenumbernei
frozen_balancenumbernei
concurrencyintegernei
statusstringnei
last_active_atstringnei; kan være null
created_atstringnei
updated_atstringnei
deleted_atstringnei; kan være null
balance_notify_enabledbooleannei
balance_notify_threshold_typestringnei
balance_notify_thresholdnumbernei; kan være null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynei
total_rechargednumbernei
rpm_limitintegernei
api_keysarray · items: APIKey · APIKeynei
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
idintegernei
titlestringnei
contentstringnei
notify_modestringnei
starts_atstringnei; kan være null
ends_atstringnei; kan være null
read_atstringnei; kan være null
created_atstringnei
updated_atstringnei
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
total_api_keysintegernei
active_api_keysintegernei
total_requestsintegernei
total_input_tokensintegernei
total_output_tokensintegernei
total_cache_creation_tokensintegernei
total_cache_read_tokensintegernei
total_tokensintegernei
total_costnumbernei; Samlet kostnad til standardpris
total_actual_costnumbernei; Samlet faktisk belastning
today_requestsintegernei
today_input_tokensintegernei
today_output_tokensintegernei
today_cache_creation_tokensintegernei
today_cache_read_tokensintegernei
today_tokensintegernei
today_costnumbernei; Dagens kostnad til standardpris
today_actual_costnumbernei; Faktisk belastning i dag
average_duration_msnumbernei
rpmintegernei; Gjennomsnittlig antall forespørsler per minutt de siste 5 minuttene
tpmintegernei; Gjennomsnittlig antall tokener per minutt de siste 5 minuttene
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
idintegernei
emailstringnei
usernamestringnei
rolestringnei
balancenumbernei
frozen_balancenumbernei
concurrencyintegernei
statusstringnei
last_active_atstringnei; kan være null
created_atstringnei
updated_atstringnei
deleted_atstringnei; kan være null
balance_notify_enabledbooleannei
balance_notify_threshold_typestringnei
balance_notify_thresholdnumbernei; kan være null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynei
total_rechargednumbernei
rpm_limitintegernei
api_keysarray · items: APIKey · APIKeynei
avatar_urlstringnei
email_boundbooleannei
Objektfelter
{
  "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

FeltetTypePåkrevdValidering / beskrivelse
codestringjarequired
Objektfelter
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

FeltetTypePåkrevdValidering / beskrivelse
validbooleannei
error_codestringnei
Objektfelter
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

FeltetTypePåkrevdValidering / beskrivelse
codestringjarequired
Objektfelter
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

FeltetTypePåkrevdValidering / beskrivelse
validbooleannei
bonus_amountnumbernei
error_codestringnei
messagestringnei
Objektfelter
{
  "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"
    }
  }
}
Flere spørsmål? Send Request ID og en beskrivelse, så hjelper vi deg.Kontakt brukerstøtte
Logg innRegistrer degKontrollpanel
Priser