dokumentaatio
Hallintapaneeli
Hallintapaneelin API

Tietoskeemat

Markdown

Hallintapaneelin APIn objektien kentät ja tyypit.

Koko opas

Hallintapaneelin APIn objektien kentät ja niiden tyypit. omitempty tarkoittaa, että kenttä voi puuttua vastauksesta; se ei anna lupaa lähettää null-arvoa. PLACEHOLDER-merkkijonot ilmaisevat tyypin, eivät oikeaa vastausta.

APIKey

KenttäTyyppiPakollinenTarkistus / kuvaus
idintegerei
user_idintegerei
keystringei
namestringei
statusstringei
ip_whitelistarray · items: stringei
ip_blacklistarray · items: stringei
last_used_atstringei; voi olla null
last_used_ipstringei; voi olla null
quotanumberei; Avaimen kulutusraja USD:na; 0 — ei rajaa
quota_usednumberei; Avaimen rajasta käytetty määrä, USD
expires_atstringei; Voimassaoloaika; null — ei päättymisaikaa; voi olla null
created_atstringei
updated_atstringei
current_concurrencyintegerei
rate_limit_5hnumberei
rate_limit_1dnumberei
rate_limit_7dnumberei
usage_5hnumberei
usage_1dnumberei
usage_7dnumberei
window_5h_startstringei; voi olla null
window_1d_startstringei; voi olla null
window_7d_startstringei; voi olla null
reset_5h_atstringei; voi olla null
reset_1d_atstringei; voi olla null
reset_7d_atstringei; voi olla null
userobject · Userei; voi olla null
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
datestringei
requestsintegerei
input_tokensintegerei
output_tokensintegerei
cache_read_tokensintegerei
cache_write_tokensintegerei
total_tokensintegerei
costnumberei; Vakiohinnan mukainen hinta
actual_costnumberei; Toteutunut veloitus
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
access_tokenstringei
refresh_tokenstringei; Istunnon päivitystoken
expires_inintegerei; Käyttöoikeustokenin voimassaoloaika sekunteina
token_typestringei
userobject · Userei; voi olla null
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
api_key_idsarray · items: integer (int64)kyllärequired
Objektin kentät
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

KenttäTyyppiPakollinenTarkistus / kuvaus
api_key_idintegerei
today_actual_costnumberei
total_actual_costnumberei
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
old_passwordstringkyllärequired
new_passwordstringkyllärequired,min=6
Objektin kentät
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
namestringkyllärequired
custom_keystringei; Valinnainen oma avainarvo; voi olla null
ip_whitelistarray · items: stringei; Sallittujen IP-osoitteiden luettelo
ip_blacklistarray · items: stringei; Estettyjen IP-osoitteiden luettelo
quotanumberei; Avaimen kulutusraja USD:na; voi olla null
expires_in_daysintegerei; Voimassaoloaika päivinä; voi olla null
rate_limit_5hnumberei; voi olla null
rate_limit_1dnumberei; voi olla null
rate_limit_7dnumberei; voi olla null
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
emailstringkyllärequired,email
turnstile_tokenstringei
Objektin kentät
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
messagestringei
Objektin kentät
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

KenttäTyyppiPakollinenTarkistus / kuvaus
temp_tokenstringkyllärequired
totp_codestringkyllärequired,len=6
Objektin kentät
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
emailstringkyllärequired,email
passwordstringkyllärequired
turnstile_tokenstringei
Objektin kentät
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
refresh_tokenstringei; Valinnainen: mitätöi annettu päivitystoken
Objektin kentät
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
messagestringei
Objektin kentät
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
turnstile_tokenstringei
Objektin kentät
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

KenttäTyyppiPakollinenTarkistus / kuvaus
idintegerei
namestringei
created_atstringei
last_used_atstringei; voi olla null
backupbooleanei
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
session_tokenstringkyllärequired
namestringei
credentialobject · WebAuthn PublicKeyCredential JSONkyllärequired
Objektin kentät
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
session_tokenstringei
optionsanyei
Objektin kentät
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

KenttäTyyppiPakollinenTarkistus / kuvaus
idintegerei
codestringei
typestringei
valuenumberei
statusstringei
used_byintegerei; voi olla null
used_atstringei; voi olla null
created_atstringei
expires_atstringei; voi olla null
validity_daysintegerei
notesstringei; voi olla null
userobject · Userei; voi olla null
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
codestringkyllärequired
Objektin kentät
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
refresh_tokenstringkyllärequired
Objektin kentät
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
access_tokenstringei
refresh_tokenstringei
expires_inintegerei; Käyttöoikeustokenin voimassaoloaika sekunteina
token_typestringei
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
emailstringkyllärequired,email
passwordstringkyllärequired,min=6
verify_codestringei
turnstile_tokenstringei
promo_codestringei; Rekisteröinnin kampanjakoodi
invitation_codestringei; Kutsukoodi
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
emailstringkyllärequired,email
tokenstringkyllärequired
new_passwordstringkyllärequired,min=6
Objektin kentät
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
messagestringei
Objektin kentät
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
messagestringei
Objektin kentät
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
emailstringkyllärequired,email
turnstile_tokenstringei
Objektin kentät
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
messagestringei
countdownintegerei; Odotusaika sekunteina
Objektin kentät
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
requires_2fabooleanei
temp_tokenstringei
user_email_maskedstringei
Objektin kentät
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
enabledbooleanei
enabled_atintegerei; Unix-aikaleima; voi olla null
feature_enabledbooleanei
Objektin kentät
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
namestringei
statusstringeiomitempty,oneof=active inactive
ip_whitelistarray · items: stringei; Sallitut IP-osoitteet: null ei muuta luetteloa, tyhjä taulukko tyhjentää sen; voi olla null
ip_blacklistarray · items: stringei; Estetyt IP-osoitteet: null ei muuta luetteloa, tyhjä taulukko tyhjentää sen; voi olla null
quotanumberei; Avaimen kulutusraja USD:na; 0 — ei rajaa; voi olla null
expires_atstringei; Voimassaolon päättymisaika ISO 8601 -muodossa; voi olla null
reset_quotabooleanei; Nollaa kulutusrajasta käytetty osuus; voi olla null
rate_limit_5hnumberei; voi olla null
rate_limit_1dnumberei; voi olla null
rate_limit_7dnumberei; voi olla null
reset_rate_limit_usagebooleanei; Nollaa jaksojen rajoihin laskettu kulutus; voi olla null
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
usernamestringei; voi olla null
avatar_urlstringei; voi olla null
balance_notify_enabledbooleanei; voi olla null
balance_notify_thresholdnumberei; voi olla null
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
idintegerei
user_idintegerei
api_key_idintegerei
request_idstringei
modelstringei
service_tierstringei; voi olla null
reasoning_effortstringei; voi olla null
input_tokensintegerei
output_tokensintegerei
cache_creation_tokensintegerei
cache_read_tokensintegerei
cache_creation_5m_tokensintegerei
cache_creation_1h_tokensintegerei
input_costnumberei
output_costnumberei
cache_creation_costnumberei
cache_read_costnumberei
total_costnumberei
actual_costnumberei
long_context_billing_appliedbooleanei
request_typestringei
streambooleanei
duration_msintegerei; voi olla null
first_token_msintegerei; voi olla null
image_countintegerei
image_sizestringei; voi olla null
image_input_sizestringei; voi olla null
image_output_sizestringei; voi olla null
image_input_tokensintegerei
image_input_costnumberei
image_output_tokensintegerei
image_output_costnumberei
image_size_breakdownobject · additionalProperties: integerei
media_typestringei; voi olla null
ip_addressstringei; voi olla null
session_idstringei; voi olla null
created_atstringei
userobject · Userei; voi olla null
api_keyobject · APIKeyei; voi olla null
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
total_requestsintegerei
total_input_tokensintegerei
total_output_tokensintegerei
total_cache_tokensintegerei
total_cache_creation_tokensintegerei
total_cache_read_tokensintegerei
total_tokensintegerei
total_costnumberei
total_actual_costnumberei
average_duration_msnumberei
endpointsarray · items: EndpointStat · EndpointStatei
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
idintegerei
emailstringei
usernamestringei
rolestringei
balancenumberei
frozen_balancenumberei
concurrencyintegerei
statusstringei
last_active_atstringei; voi olla null
created_atstringei
updated_atstringei
deleted_atstringei; voi olla null
balance_notify_enabledbooleanei
balance_notify_threshold_typestringei
balance_notify_thresholdnumberei; voi olla null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryei
total_rechargednumberei
rpm_limitintegerei
api_keysarray · items: APIKey · APIKeyei
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
idintegerei
titlestringei
contentstringei
notify_modestringei
starts_atstringei; voi olla null
ends_atstringei; voi olla null
read_atstringei; voi olla null
created_atstringei
updated_atstringei
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
total_api_keysintegerei
active_api_keysintegerei
total_requestsintegerei
total_input_tokensintegerei
total_output_tokensintegerei
total_cache_creation_tokensintegerei
total_cache_read_tokensintegerei
total_tokensintegerei
total_costnumberei; Kokonaishinta vakiohinnan mukaan
total_actual_costnumberei; Toteutunut kokonaisveloitus
today_requestsintegerei
today_input_tokensintegerei
today_output_tokensintegerei
today_cache_creation_tokensintegerei
today_cache_read_tokensintegerei
today_tokensintegerei
today_costnumberei; Tämän päivän hinta vakiohinnan mukaan
today_actual_costnumberei; Tämän päivän toteutunut veloitus
average_duration_msnumberei
rpmintegerei; Keskimääräinen pyyntömäärä minuutissa viimeisten 5 minuutin aikana
tpmintegerei; Keskimääräinen tokenimäärä minuutissa viimeisten 5 minuutin aikana
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
idintegerei
emailstringei
usernamestringei
rolestringei
balancenumberei
frozen_balancenumberei
concurrencyintegerei
statusstringei
last_active_atstringei; voi olla null
created_atstringei
updated_atstringei
deleted_atstringei; voi olla null
balance_notify_enabledbooleanei
balance_notify_threshold_typestringei
balance_notify_thresholdnumberei; voi olla null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryei
total_rechargednumberei
rpm_limitintegerei
api_keysarray · items: APIKey · APIKeyei
avatar_urlstringei
email_boundbooleanei
Objektin kentät
{
  "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

KenttäTyyppiPakollinenTarkistus / kuvaus
codestringkyllärequired
Objektin kentät
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
validbooleanei
error_codestringei
Objektin kentät
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

KenttäTyyppiPakollinenTarkistus / kuvaus
codestringkyllärequired
Objektin kentät
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

KenttäTyyppiPakollinenTarkistus / kuvaus
validbooleanei
bonus_amountnumberei
error_codestringei
messagestringei
Objektin kentät
{
  "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"
    }
  }
}
Onko vielä kysyttävää? Lähetä Request ID ja kuvaus — autamme selvittämään asian.Ota yhteyttä tukeen
Kirjaudu sisäänRekisteröidyHallintapaneeli
Hinnoittelu