dokumentácia
Používateľský účet
API používateľského účtu

Dátové schémy

Markdown

Polia a typy objektov API používateľského účtu.

Úplný sprievodca

Polia objektov API používateľského účtu a ich typy. omitempty znamená, že pole môže v odpovedi chýbať; neznamená to povolenie odoslať null. Reťazce PLACEHOLDER označujú typ, nie skutočnú odpoveď.

APIKey

PoleTypPovinnéKontrola / opis
idintegernie
user_idintegernie
keystringnie
namestringnie
statusstringnie
ip_whitelistarray · items: stringnie
ip_blacklistarray · items: stringnie
last_used_atstringnie; môže byť null
last_used_ipstringnie; môže byť null
quotanumbernie; Limit výdavkov kľúča v USD; 0 znamená bez limitu
quota_usednumbernie; Vyčerpaná časť limitu kľúča, USD
expires_atstringnie; Platnosť; null znamená neobmedzenú platnosť; môže byť null
created_atstringnie
updated_atstringnie
current_concurrencyintegernie
rate_limit_5hnumbernie
rate_limit_1dnumbernie
rate_limit_7dnumbernie
usage_5hnumbernie
usage_1dnumbernie
usage_7dnumbernie
window_5h_startstringnie; môže byť null
window_1d_startstringnie; môže byť null
window_7d_startstringnie; môže byť null
reset_5h_atstringnie; môže byť null
reset_1d_atstringnie; môže byť null
reset_7d_atstringnie; môže byť null
userobject · Usernie; môže byť null
Polia 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 / opis
datestringnie
requestsintegernie
input_tokensintegernie
output_tokensintegernie
cache_read_tokensintegernie
cache_write_tokensintegernie
total_tokensintegernie
costnumbernie; Cena podľa štandardného cenníka
actual_costnumbernie; Skutočne zaúčtovaná suma
Polia 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 / opis
access_tokenstringnie
refresh_tokenstringnie; Token na obnovenie relácie
expires_inintegernie; Platnosť prístupového tokenu v sekundách
token_typestringnie
userobject · Usernie; môže byť null
Polia 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 / opis
api_key_idsarray · items: integer (int64)ánorequired
Polia objektu
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

PoleTypPovinnéKontrola / opis
api_key_idintegernie
today_actual_costnumbernie
total_actual_costnumbernie
Polia 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 / opis
old_passwordstringánorequired
new_passwordstringánorequired,min=6
Polia objektu
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

PoleTypPovinnéKontrola / opis
namestringánorequired
custom_keystringnie; Voliteľná vlastná hodnota kľúča; môže byť null
ip_whitelistarray · items: stringnie; Zoznam povolených IP
ip_blacklistarray · items: stringnie; Zoznam zakázaných IP
quotanumbernie; Limit výdavkov kľúča v USD; môže byť null
expires_in_daysintegernie; Platnosť v dňoch; môže byť null
rate_limit_5hnumbernie; môže byť null
rate_limit_1dnumbernie; môže byť null
rate_limit_7dnumbernie; môže byť null
Polia 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 / opis
emailstringánorequired,email
turnstile_tokenstringnie
Polia objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

PoleTypPovinnéKontrola / opis
messagestringnie
Polia objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

PoleTypPovinnéKontrola / opis
temp_tokenstringánorequired
totp_codestringánorequired,len=6
Polia objektu
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

PoleTypPovinnéKontrola / opis
emailstringánorequired,email
passwordstringánorequired
turnstile_tokenstringnie
Polia objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

PoleTypPovinnéKontrola / opis
refresh_tokenstringnie; Voliteľne: zneplatniť uvedený obnovovací token
Polia objektu
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

PoleTypPovinnéKontrola / opis
messagestringnie
Polia objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

PoleTypPovinnéKontrola / opis
turnstile_tokenstringnie
Polia objektu
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

PoleTypPovinnéKontrola / opis
idintegernie
namestringnie
created_atstringnie
last_used_atstringnie; môže byť null
backupbooleannie
Polia 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 / opis
session_tokenstringánorequired
namestringnie
credentialobject · WebAuthn PublicKeyCredential JSONánorequired
Polia objektu
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

PoleTypPovinnéKontrola / opis
session_tokenstringnie
optionsanynie
Polia objektu
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

PoleTypPovinnéKontrola / opis
idintegernie
codestringnie
typestringnie
valuenumbernie
statusstringnie
used_byintegernie; môže byť null
used_atstringnie; môže byť null
created_atstringnie
expires_atstringnie; môže byť null
validity_daysintegernie
notesstringnie; môže byť null
userobject · Usernie; môže byť null
Polia 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 / opis
codestringánorequired
Polia objektu
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

PoleTypPovinnéKontrola / opis
refresh_tokenstringánorequired
Polia objektu
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

PoleTypPovinnéKontrola / opis
access_tokenstringnie
refresh_tokenstringnie
expires_inintegernie; Platnosť prístupového tokenu v sekundách
token_typestringnie
Polia 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 / opis
emailstringánorequired,email
passwordstringánorequired,min=6
verify_codestringnie
turnstile_tokenstringnie
promo_codestringnie; Registračný promo kód
invitation_codestringnie; Kód pozvánky
Polia 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 / opis
emailstringánorequired,email
tokenstringánorequired
new_passwordstringánorequired,min=6
Polia objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

PoleTypPovinnéKontrola / opis
messagestringnie
Polia objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

PoleTypPovinnéKontrola / opis
messagestringnie
Polia objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

PoleTypPovinnéKontrola / opis
emailstringánorequired,email
turnstile_tokenstringnie
Polia objektu
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

PoleTypPovinnéKontrola / opis
messagestringnie
countdownintegernie; Čas čakania v sekundách
Polia objektu
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

PoleTypPovinnéKontrola / opis
requires_2fabooleannie
temp_tokenstringnie
user_email_maskedstringnie
Polia objektu
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

PoleTypPovinnéKontrola / opis
enabledbooleannie
enabled_atintegernie; Unix timestamp; môže byť null
feature_enabledbooleannie
Polia objektu
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

PoleTypPovinnéKontrola / opis
namestringnie
statusstringnieomitempty,oneof=active inactive
ip_whitelistarray · items: stringnie; Povolené IP: null nemení zoznam, prázdne pole ho vymaže; môže byť null
ip_blacklistarray · items: stringnie; Zakázané IP: null nemení zoznam, prázdne pole ho vymaže; môže byť null
quotanumbernie; Limit výdavkov kľúča v USD; 0 znamená bez limitu; môže byť null
expires_atstringnie; Čas skončenia platnosti vo formáte ISO 8601; môže byť null
reset_quotabooleannie; Vynulovať vyčerpanú časť limitu výdavkov; môže byť null
rate_limit_5hnumbernie; môže byť null
rate_limit_1dnumbernie; môže byť null
rate_limit_7dnumbernie; môže byť null
reset_rate_limit_usagebooleannie; Vynulovať spotrebu limitov za časové okná; môže byť null
Polia 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 / opis
usernamestringnie; môže byť null
avatar_urlstringnie; môže byť null
balance_notify_enabledbooleannie; môže byť null
balance_notify_thresholdnumbernie; môže byť null
Polia 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 / opis
idintegernie
user_idintegernie
api_key_idintegernie
request_idstringnie
modelstringnie
service_tierstringnie; môže byť null
reasoning_effortstringnie; môže byť null
input_tokensintegernie
output_tokensintegernie
cache_creation_tokensintegernie
cache_read_tokensintegernie
cache_creation_5m_tokensintegernie
cache_creation_1h_tokensintegernie
input_costnumbernie
output_costnumbernie
cache_creation_costnumbernie
cache_read_costnumbernie
total_costnumbernie
actual_costnumbernie
long_context_billing_appliedbooleannie
request_typestringnie
streambooleannie
duration_msintegernie; môže byť null
first_token_msintegernie; môže byť null
image_countintegernie
image_sizestringnie; môže byť null
image_input_sizestringnie; môže byť null
image_output_sizestringnie; môže byť null
image_input_tokensintegernie
image_input_costnumbernie
image_output_tokensintegernie
image_output_costnumbernie
image_size_breakdownobject · additionalProperties: integernie
media_typestringnie; môže byť null
ip_addressstringnie; môže byť null
session_idstringnie; môže byť null
created_atstringnie
userobject · Usernie; môže byť null
api_keyobject · APIKeynie; môže byť null
Polia 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 / opis
total_requestsintegernie
total_input_tokensintegernie
total_output_tokensintegernie
total_cache_tokensintegernie
total_cache_creation_tokensintegernie
total_cache_read_tokensintegernie
total_tokensintegernie
total_costnumbernie
total_actual_costnumbernie
average_duration_msnumbernie
endpointsarray · items: EndpointStat · EndpointStatnie
Polia 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 / opis
idintegernie
emailstringnie
usernamestringnie
rolestringnie
balancenumbernie
frozen_balancenumbernie
concurrencyintegernie
statusstringnie
last_active_atstringnie; môže byť null
created_atstringnie
updated_atstringnie
deleted_atstringnie; môže byť null
balance_notify_enabledbooleannie
balance_notify_threshold_typestringnie
balance_notify_thresholdnumbernie; môže byť null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynie
total_rechargednumbernie
rpm_limitintegernie
api_keysarray · items: APIKey · APIKeynie
Polia 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 / opis
idintegernie
titlestringnie
contentstringnie
notify_modestringnie
starts_atstringnie; môže byť null
ends_atstringnie; môže byť null
read_atstringnie; môže byť null
created_atstringnie
updated_atstringnie
Polia 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 / opis
total_api_keysintegernie
active_api_keysintegernie
total_requestsintegernie
total_input_tokensintegernie
total_output_tokensintegernie
total_cache_creation_tokensintegernie
total_cache_read_tokensintegernie
total_tokensintegernie
total_costnumbernie; Celková cena podľa štandardného cenníka
total_actual_costnumbernie; Celková skutočne zaúčtovaná suma
today_requestsintegernie
today_input_tokensintegernie
today_output_tokensintegernie
today_cache_creation_tokensintegernie
today_cache_read_tokensintegernie
today_tokensintegernie
today_costnumbernie; Dnešná cena podľa štandardného cenníka
today_actual_costnumbernie; Skutočne zaúčtovaná suma za dnešok
average_duration_msnumbernie
rpmintegernie; Priemerný počet požiadaviek za minútu za posledných 5 minút
tpmintegernie; Priemerný počet tokenov za minútu za posledných 5 minút
Polia 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 / opis
idintegernie
emailstringnie
usernamestringnie
rolestringnie
balancenumbernie
frozen_balancenumbernie
concurrencyintegernie
statusstringnie
last_active_atstringnie; môže byť null
created_atstringnie
updated_atstringnie
deleted_atstringnie; môže byť null
balance_notify_enabledbooleannie
balance_notify_threshold_typestringnie
balance_notify_thresholdnumbernie; môže byť null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynie
total_rechargednumbernie
rpm_limitintegernie
api_keysarray · items: APIKey · APIKeynie
avatar_urlstringnie
email_boundbooleannie
Polia 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 / opis
codestringánorequired
Polia objektu
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

PoleTypPovinnéKontrola / opis
validbooleannie
error_codestringnie
Polia objektu
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

PoleTypPovinnéKontrola / opis
codestringánorequired
Polia objektu
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

PoleTypPovinnéKontrola / opis
validbooleannie
bonus_amountnumbernie
error_codestringnie
messagestringnie
Polia 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 ďalšie otázky? Pošlite Request ID a opis problému – pomôžeme vám ho vyriešiť.Napísať podpore
Prihlásiť saRegistráciaPoužívateľský účet
Cenník