dokumentace
Uživatelský panel
API uživatelského panelu

Datová schémata

Markdown

Pole a typy objektů API uživatelského panelu.

Úplný průvodce

Pole objektů API uživatelského panelu a jejich typy. omitempty znamená, že pole může v odpovědi chybět; neopravňuje to k odeslání null. Řetězce PLACEHOLDER označují typ, nikoli skutečnou odpověď.

APIKey

PoleTypPovinnéKontrola / popis
idintegerne
user_idintegerne
keystringne
namestringne
statusstringne
ip_whitelistarray · items: stringne
ip_blacklistarray · items: stringne
last_used_atstringne; může být null
last_used_ipstringne; může být null
quotanumberne; Limit útraty klíče v USD; 0 – bez limitu
quota_usednumberne; Vyčerpáno z limitu klíče, USD
expires_atstringne; Doba platnosti; null – bez časového omezení; může být null
created_atstringne
updated_atstringne
current_concurrencyintegerne
rate_limit_5hnumberne
rate_limit_1dnumberne
rate_limit_7dnumberne
usage_5hnumberne
usage_1dnumberne
usage_7dnumberne
window_5h_startstringne; může být null
window_1d_startstringne; může být null
window_7d_startstringne; může být null
reset_5h_atstringne; může být null
reset_1d_atstringne; může být null
reset_7d_atstringne; může být null
userobject · Userne; může být null
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
datestringne
requestsintegerne
input_tokensintegerne
output_tokensintegerne
cache_read_tokensintegerne
cache_write_tokensintegerne
total_tokensintegerne
costnumberne; Náklady podle standardní ceny
actual_costnumberne; Skutečně odečtená částka
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
access_tokenstringne
refresh_tokenstringne; Token pro obnovení relace
expires_inintegerne; Doba platnosti přístupového tokenu v sekundách
token_typestringne
userobject · Userne; může být null
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
api_key_idsarray · items: integer (int64)anorequired
Pole objektu
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

PoleTypPovinnéKontrola / popis
api_key_idintegerne
today_actual_costnumberne
total_actual_costnumberne
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
old_passwordstringanorequired
new_passwordstringanorequired,min=6
Pole objektu
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

PoleTypPovinnéKontrola / popis
namestringanorequired
custom_keystringne; Nepovinná vlastní hodnota klíče; může být null
ip_whitelistarray · items: stringne; Seznam povolených IP adres
ip_blacklistarray · items: stringne; Seznam zakázaných IP adres
quotanumberne; Limit útraty klíče v USD; může být null
expires_in_daysintegerne; Doba platnosti ve dnech; může být null
rate_limit_5hnumberne; může být null
rate_limit_1dnumberne; může být null
rate_limit_7dnumberne; může být null
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
turnstile_tokenstringne
Pole objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

PoleTypPovinnéKontrola / popis
messagestringne
Pole objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

PoleTypPovinnéKontrola / popis
temp_tokenstringanorequired
totp_codestringanorequired,len=6
Pole objektu
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
passwordstringanorequired
turnstile_tokenstringne
Pole objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

PoleTypPovinnéKontrola / popis
refresh_tokenstringne; Nepovinné: zneplatnit uvedený obnovovací token
Pole objektu
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

PoleTypPovinnéKontrola / popis
messagestringne
Pole objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

PoleTypPovinnéKontrola / popis
turnstile_tokenstringne
Pole objektu
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

PoleTypPovinnéKontrola / popis
idintegerne
namestringne
created_atstringne
last_used_atstringne; může být null
backupbooleanne
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
session_tokenstringanorequired
namestringne
credentialobject · WebAuthn PublicKeyCredential JSONanorequired
Pole objektu
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

PoleTypPovinnéKontrola / popis
session_tokenstringne
optionsanyne
Pole objektu
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

PoleTypPovinnéKontrola / popis
idintegerne
codestringne
typestringne
valuenumberne
statusstringne
used_byintegerne; může být null
used_atstringne; může být null
created_atstringne
expires_atstringne; může být null
validity_daysintegerne
notesstringne; může být null
userobject · Userne; může být null
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
codestringanorequired
Pole objektu
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

PoleTypPovinnéKontrola / popis
refresh_tokenstringanorequired
Pole objektu
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

PoleTypPovinnéKontrola / popis
access_tokenstringne
refresh_tokenstringne
expires_inintegerne; Doba platnosti přístupového tokenu v sekundách
token_typestringne
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
passwordstringanorequired,min=6
verify_codestringne
turnstile_tokenstringne
promo_codestringne; Registrační promo kód
invitation_codestringne; Kód pozvánky
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
tokenstringanorequired
new_passwordstringanorequired,min=6
Pole objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

PoleTypPovinnéKontrola / popis
messagestringne
Pole objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

PoleTypPovinnéKontrola / popis
messagestringne
Pole objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

PoleTypPovinnéKontrola / popis
emailstringanorequired,email
turnstile_tokenstringne
Pole objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

PoleTypPovinnéKontrola / popis
messagestringne
countdownintegerne; Doba čekání v sekundách
Pole objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

PoleTypPovinnéKontrola / popis
requires_2fabooleanne
temp_tokenstringne
user_email_maskedstringne
Pole objektu
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

PoleTypPovinnéKontrola / popis
enabledbooleanne
enabled_atintegerne; Časové razítko Unix; může být null
feature_enabledbooleanne
Pole objektu
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

PoleTypPovinnéKontrola / popis
namestringne
statusstringneomitempty,oneof=active inactive
ip_whitelistarray · items: stringne; Povolené IP adresy: null seznam nemění, prázdné pole seznam vyprázdní; může být null
ip_blacklistarray · items: stringne; Zakázané IP adresy: null seznam nemění, prázdné pole seznam vyprázdní; může být null
quotanumberne; Limit útraty klíče v USD; 0 – bez limitu; může být null
expires_atstringne; Čas vypršení platnosti ve formátu ISO 8601; může být null
reset_quotabooleanne; Vynulovat již vyčerpanou část limitu útraty; může být null
rate_limit_5hnumberne; může být null
rate_limit_1dnumberne; může být null
rate_limit_7dnumberne; může být null
reset_rate_limit_usagebooleanne; Vynulovat čerpání limitů za časová okna; může být null
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
usernamestringne; může být null
avatar_urlstringne; může být null
balance_notify_enabledbooleanne; může být null
balance_notify_thresholdnumberne; může být null
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
idintegerne
user_idintegerne
api_key_idintegerne
request_idstringne
modelstringne
service_tierstringne; může být null
reasoning_effortstringne; může být null
input_tokensintegerne
output_tokensintegerne
cache_creation_tokensintegerne
cache_read_tokensintegerne
cache_creation_5m_tokensintegerne
cache_creation_1h_tokensintegerne
input_costnumberne
output_costnumberne
cache_creation_costnumberne
cache_read_costnumberne
total_costnumberne
actual_costnumberne
long_context_billing_appliedbooleanne
request_typestringne
streambooleanne
duration_msintegerne; může být null
first_token_msintegerne; může být null
image_countintegerne
image_sizestringne; může být null
image_input_sizestringne; může být null
image_output_sizestringne; může být null
image_input_tokensintegerne
image_input_costnumberne
image_output_tokensintegerne
image_output_costnumberne
image_size_breakdownobject · additionalProperties: integerne
media_typestringne; může být null
ip_addressstringne; může být null
session_idstringne; může být null
created_atstringne
userobject · Userne; může být null
api_keyobject · APIKeyne; může být null
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
total_requestsintegerne
total_input_tokensintegerne
total_output_tokensintegerne
total_cache_tokensintegerne
total_cache_creation_tokensintegerne
total_cache_read_tokensintegerne
total_tokensintegerne
total_costnumberne
total_actual_costnumberne
average_duration_msnumberne
endpointsarray · items: EndpointStat · EndpointStatne
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
idintegerne
emailstringne
usernamestringne
rolestringne
balancenumberne
frozen_balancenumberne
concurrencyintegerne
statusstringne
last_active_atstringne; může být null
created_atstringne
updated_atstringne
deleted_atstringne; může být null
balance_notify_enabledbooleanne
balance_notify_threshold_typestringne
balance_notify_thresholdnumberne; může být null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryne
total_rechargednumberne
rpm_limitintegerne
api_keysarray · items: APIKey · APIKeyne
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
idintegerne
titlestringne
contentstringne
notify_modestringne
starts_atstringne; může být null
ends_atstringne; může být null
read_atstringne; může být null
created_atstringne
updated_atstringne
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
total_api_keysintegerne
active_api_keysintegerne
total_requestsintegerne
total_input_tokensintegerne
total_output_tokensintegerne
total_cache_creation_tokensintegerne
total_cache_read_tokensintegerne
total_tokensintegerne
total_costnumberne; Celkové náklady podle standardní ceny
total_actual_costnumberne; Celková skutečně odečtená částka
today_requestsintegerne
today_input_tokensintegerne
today_output_tokensintegerne
today_cache_creation_tokensintegerne
today_cache_read_tokensintegerne
today_tokensintegerne
today_costnumberne; Dnešní náklady podle standardní ceny
today_actual_costnumberne; Skutečně odečtená částka za dnešek
average_duration_msnumberne
rpmintegerne; Průměrný počet požadavků za minutu za posledních 5 minut
tpmintegerne; Průměrný počet tokenů za minutu za posledních 5 minut
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
idintegerne
emailstringne
usernamestringne
rolestringne
balancenumberne
frozen_balancenumberne
concurrencyintegerne
statusstringne
last_active_atstringne; může být null
created_atstringne
updated_atstringne
deleted_atstringne; může být null
balance_notify_enabledbooleanne
balance_notify_threshold_typestringne
balance_notify_thresholdnumberne; může být null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryne
total_rechargednumberne
rpm_limitintegerne
api_keysarray · items: APIKey · APIKeyne
avatar_urlstringne
email_boundbooleanne
Pole objektu
{
  "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

PoleTypPovinnéKontrola / popis
codestringanorequired
Pole objektu
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

PoleTypPovinnéKontrola / popis
validbooleanne
error_codestringne
Pole objektu
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

PoleTypPovinnéKontrola / popis
codestringanorequired
Pole objektu
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

PoleTypPovinnéKontrola / popis
validbooleanne
bonus_amountnumberne
error_codestringne
messagestringne
Pole objektu
{
  "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"
    }
  }
}
Máte další dotazy? Pošlete Request ID a popis – pomůžeme situaci objasnit.Napsat podpoře
Přihlásit seRegistraceUživatelský panel
Tarify