docs
Жеке кабинет
Жеке кабинет API-і

Деректер схемалары

Markdown

Жеке кабинет API нысандарының өрістері мен түрлері.

Толық нұсқаулық

Жеке кабинет API нысандарының өрістері мен олардың түрлері. omitempty өрістің жауапта болмауы мүмкін екенін білдіреді; бұл null жіберуге рұқсат емес. PLACEHOLDER жолдары нақты жауапты емес, түрді білдіреді.

APIKey

ӨрісТүріМіндеттіТексеру / сипаттама
idintegerжоқ
user_idintegerжоқ
keystringжоқ
namestringжоқ
statusstringжоқ
ip_whitelistarray · items: stringжоқ
ip_blacklistarray · items: stringжоқ
last_used_atstringжоқ; null болуы мүмкін
last_used_ipstringжоқ; null болуы мүмкін
quotanumberжоқ; Кілттің USD түріндегі шығын лимиті; 0 — лимитсіз
quota_usednumberжоқ; Кілт лимитінен жұмсалған сома, USD
expires_atstringжоқ; Жарамдылық мерзімі; null — мерзімсіз; null болуы мүмкін
created_atstringжоқ
updated_atstringжоқ
current_concurrencyintegerжоқ
rate_limit_5hnumberжоқ
rate_limit_1dnumberжоқ
rate_limit_7dnumberжоқ
usage_5hnumberжоқ
usage_1dnumberжоқ
usage_7dnumberжоқ
window_5h_startstringжоқ; null болуы мүмкін
window_1d_startstringжоқ; null болуы мүмкін
window_7d_startstringжоқ; null болуы мүмкін
reset_5h_atstringжоқ; null болуы мүмкін
reset_1d_atstringжоқ; null болуы мүмкін
reset_7d_atstringжоқ; null болуы мүмкін
userobject · Userжоқ; null болуы мүмкін
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
datestringжоқ
requestsintegerжоқ
input_tokensintegerжоқ
output_tokensintegerжоқ
cache_read_tokensintegerжоқ
cache_write_tokensintegerжоқ
total_tokensintegerжоқ
costnumberжоқ; Стандартты бағамен құны
actual_costnumberжоқ; Нақты есептен шығару
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
access_tokenstringжоқ
refresh_tokenstringжоқ; Сеансты жаңарту токені
expires_inintegerжоқ; Қол жеткізу токенінің секундпен берілген жарамдылық мерзімі
token_typestringжоқ
userobject · Userжоқ; null болуы мүмкін
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
api_key_idsarray · items: integer (int64)иәrequired
Нысан өрістері
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

ӨрісТүріМіндеттіТексеру / сипаттама
api_key_idintegerжоқ
today_actual_costnumberжоқ
total_actual_costnumberжоқ
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
old_passwordstringиәrequired
new_passwordstringиәrequired,min=6
Нысан өрістері
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

ӨрісТүріМіндеттіТексеру / сипаттама
namestringиәrequired
custom_keystringжоқ; Кілттің өз мәні, міндетті емес; null болуы мүмкін
ip_whitelistarray · items: stringжоқ; Рұқсат етілген IP тізімі
ip_blacklistarray · items: stringжоқ; Тыйым салынған IP тізімі
quotanumberжоқ; Кілттің USD түріндегі шығын лимиті; null болуы мүмкін
expires_in_daysintegerжоқ; Күнмен берілген жарамдылық мерзімі; null болуы мүмкін
rate_limit_5hnumberжоқ; null болуы мүмкін
rate_limit_1dnumberжоқ; null болуы мүмкін
rate_limit_7dnumberжоқ; null болуы мүмкін
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
emailstringиәrequired,email
turnstile_tokenstringжоқ
Нысан өрістері
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

ӨрісТүріМіндеттіТексеру / сипаттама
messagestringжоқ
Нысан өрістері
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

ӨрісТүріМіндеттіТексеру / сипаттама
temp_tokenstringиәrequired
totp_codestringиәrequired,len=6
Нысан өрістері
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

ӨрісТүріМіндеттіТексеру / сипаттама
emailstringиәrequired,email
passwordstringиәrequired
turnstile_tokenstringжоқ
Нысан өрістері
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

ӨрісТүріМіндеттіТексеру / сипаттама
refresh_tokenstringжоқ; Міндетті емес: көрсетілген жаңарту токенін қайтарып алу
Нысан өрістері
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

ӨрісТүріМіндеттіТексеру / сипаттама
messagestringжоқ
Нысан өрістері
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

ӨрісТүріМіндеттіТексеру / сипаттама
turnstile_tokenstringжоқ
Нысан өрістері
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

ӨрісТүріМіндеттіТексеру / сипаттама
idintegerжоқ
namestringжоқ
created_atstringжоқ
last_used_atstringжоқ; null болуы мүмкін
backupbooleanжоқ
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
session_tokenstringиәrequired
namestringжоқ
credentialobject · WebAuthn PublicKeyCredential JSONиәrequired
Нысан өрістері
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

ӨрісТүріМіндеттіТексеру / сипаттама
session_tokenstringжоқ
optionsanyжоқ
Нысан өрістері
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

ӨрісТүріМіндеттіТексеру / сипаттама
idintegerжоқ
codestringжоқ
typestringжоқ
valuenumberжоқ
statusstringжоқ
used_byintegerжоқ; null болуы мүмкін
used_atstringжоқ; null болуы мүмкін
created_atstringжоқ
expires_atstringжоқ; null болуы мүмкін
validity_daysintegerжоқ
notesstringжоқ; null болуы мүмкін
userobject · Userжоқ; null болуы мүмкін
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
codestringиәrequired
Нысан өрістері
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

ӨрісТүріМіндеттіТексеру / сипаттама
refresh_tokenstringиәrequired
Нысан өрістері
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

ӨрісТүріМіндеттіТексеру / сипаттама
access_tokenstringжоқ
refresh_tokenstringжоқ
expires_inintegerжоқ; Қол жеткізу токенінің секундпен берілген жарамдылық мерзімі
token_typestringжоқ
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
emailstringиәrequired,email
passwordstringиәrequired,min=6
verify_codestringжоқ
turnstile_tokenstringжоқ
promo_codestringжоқ; Тіркелу промокоды
invitation_codestringжоқ; Шақыру коды
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
emailstringиәrequired,email
tokenstringиәrequired
new_passwordstringиәrequired,min=6
Нысан өрістері
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

ӨрісТүріМіндеттіТексеру / сипаттама
messagestringжоқ
Нысан өрістері
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

ӨрісТүріМіндеттіТексеру / сипаттама
messagestringжоқ
Нысан өрістері
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

ӨрісТүріМіндеттіТексеру / сипаттама
emailstringиәrequired,email
turnstile_tokenstringжоқ
Нысан өрістері
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

ӨрісТүріМіндеттіТексеру / сипаттама
messagestringжоқ
countdownintegerжоқ; Секундпен берілген күту уақыты
Нысан өрістері
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

ӨрісТүріМіндеттіТексеру / сипаттама
requires_2fabooleanжоқ
temp_tokenstringжоқ
user_email_maskedstringжоқ
Нысан өрістері
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

ӨрісТүріМіндеттіТексеру / сипаттама
enabledbooleanжоқ
enabled_atintegerжоқ; Unix timestamp; null болуы мүмкін
feature_enabledbooleanжоқ
Нысан өрістері
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

ӨрісТүріМіндеттіТексеру / сипаттама
namestringжоқ
statusstringжоқomitempty,oneof=active inactive
ip_whitelistarray · items: stringжоқ; Рұқсат етілген IP: null тізімді өзгертпейді, бос массив оны тазартады; null болуы мүмкін
ip_blacklistarray · items: stringжоқ; Тыйым салынған IP: null тізімді өзгертпейді, бос массив оны тазартады; null болуы мүмкін
quotanumberжоқ; Кілттің USD түріндегі шығын лимиті; 0 — лимитсіз; null болуы мүмкін
expires_atstringжоқ; ISO 8601 форматындағы жарамдылық мерзімінің аяқталу уақыты; null болуы мүмкін
reset_quotabooleanжоқ; Шығын лимитінің жұмсалған бөлігін нөлдеу; null болуы мүмкін
rate_limit_5hnumberжоқ; null болуы мүмкін
rate_limit_1dnumberжоқ; null болуы мүмкін
rate_limit_7dnumberжоқ; null болуы мүмкін
reset_rate_limit_usagebooleanжоқ; Уақыт аралықтарындағы лимит шығындарын нөлдеу; null болуы мүмкін
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
usernamestringжоқ; null болуы мүмкін
avatar_urlstringжоқ; null болуы мүмкін
balance_notify_enabledbooleanжоқ; null болуы мүмкін
balance_notify_thresholdnumberжоқ; null болуы мүмкін
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
idintegerжоқ
user_idintegerжоқ
api_key_idintegerжоқ
request_idstringжоқ
modelstringжоқ
service_tierstringжоқ; null болуы мүмкін
reasoning_effortstringжоқ; null болуы мүмкін
input_tokensintegerжоқ
output_tokensintegerжоқ
cache_creation_tokensintegerжоқ
cache_read_tokensintegerжоқ
cache_creation_5m_tokensintegerжоқ
cache_creation_1h_tokensintegerжоқ
input_costnumberжоқ
output_costnumberжоқ
cache_creation_costnumberжоқ
cache_read_costnumberжоқ
total_costnumberжоқ
actual_costnumberжоқ
long_context_billing_appliedbooleanжоқ
request_typestringжоқ
streambooleanжоқ
duration_msintegerжоқ; null болуы мүмкін
first_token_msintegerжоқ; null болуы мүмкін
image_countintegerжоқ
image_sizestringжоқ; null болуы мүмкін
image_input_sizestringжоқ; null болуы мүмкін
image_output_sizestringжоқ; null болуы мүмкін
image_input_tokensintegerжоқ
image_input_costnumberжоқ
image_output_tokensintegerжоқ
image_output_costnumberжоқ
image_size_breakdownobject · additionalProperties: integerжоқ
media_typestringжоқ; null болуы мүмкін
ip_addressstringжоқ; null болуы мүмкін
session_idstringжоқ; null болуы мүмкін
created_atstringжоқ
userobject · Userжоқ; null болуы мүмкін
api_keyobject · APIKeyжоқ; null болуы мүмкін
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
total_requestsintegerжоқ
total_input_tokensintegerжоқ
total_output_tokensintegerжоқ
total_cache_tokensintegerжоқ
total_cache_creation_tokensintegerжоқ
total_cache_read_tokensintegerжоқ
total_tokensintegerжоқ
total_costnumberжоқ
total_actual_costnumberжоқ
average_duration_msnumberжоқ
endpointsarray · items: EndpointStat · EndpointStatжоқ
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
idintegerжоқ
emailstringжоқ
usernamestringжоқ
rolestringжоқ
balancenumberжоқ
frozen_balancenumberжоқ
concurrencyintegerжоқ
statusstringжоқ
last_active_atstringжоқ; null болуы мүмкін
created_atstringжоқ
updated_atstringжоқ
deleted_atstringжоқ; null болуы мүмкін
balance_notify_enabledbooleanжоқ
balance_notify_threshold_typestringжоқ
balance_notify_thresholdnumberжоқ; null болуы мүмкін
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryжоқ
total_rechargednumberжоқ
rpm_limitintegerжоқ
api_keysarray · items: APIKey · APIKeyжоқ
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
idintegerжоқ
titlestringжоқ
contentstringжоқ
notify_modestringжоқ
starts_atstringжоқ; null болуы мүмкін
ends_atstringжоқ; null болуы мүмкін
read_atstringжоқ; null болуы мүмкін
created_atstringжоқ
updated_atstringжоқ
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
total_api_keysintegerжоқ
active_api_keysintegerжоқ
total_requestsintegerжоқ
total_input_tokensintegerжоқ
total_output_tokensintegerжоқ
total_cache_creation_tokensintegerжоқ
total_cache_read_tokensintegerжоқ
total_tokensintegerжоқ
total_costnumberжоқ; Стандартты бағамен жалпы құны
total_actual_costnumberжоқ; Жалпы нақты есептен шығару
today_requestsintegerжоқ
today_input_tokensintegerжоқ
today_output_tokensintegerжоқ
today_cache_creation_tokensintegerжоқ
today_cache_read_tokensintegerжоқ
today_tokensintegerжоқ
today_costnumberжоқ; Стандартты бағамен бүгінгі құны
today_actual_costnumberжоқ; Бүгінгі нақты есептен шығару
average_duration_msnumberжоқ
rpmintegerжоқ; Соңғы 5 минуттағы бір минутқа шаққандағы орташа сұрау саны
tpmintegerжоқ; Соңғы 5 минуттағы бір минутқа шаққандағы орташа токен саны
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
idintegerжоқ
emailstringжоқ
usernamestringжоқ
rolestringжоқ
balancenumberжоқ
frozen_balancenumberжоқ
concurrencyintegerжоқ
statusstringжоқ
last_active_atstringжоқ; null болуы мүмкін
created_atstringжоқ
updated_atstringжоқ
deleted_atstringжоқ; null болуы мүмкін
balance_notify_enabledbooleanжоқ
balance_notify_threshold_typestringжоқ
balance_notify_thresholdnumberжоқ; null болуы мүмкін
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryжоқ
total_rechargednumberжоқ
rpm_limitintegerжоқ
api_keysarray · items: APIKey · APIKeyжоқ
avatar_urlstringжоқ
email_boundbooleanжоқ
Нысан өрістері
{
  "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

ӨрісТүріМіндеттіТексеру / сипаттама
codestringиәrequired
Нысан өрістері
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

ӨрісТүріМіндеттіТексеру / сипаттама
validbooleanжоқ
error_codestringжоқ
Нысан өрістері
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

ӨрісТүріМіндеттіТексеру / сипаттама
codestringиәrequired
Нысан өрістері
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

ӨрісТүріМіндеттіТексеру / сипаттама
validbooleanжоқ
bonus_amountnumberжоқ
error_codestringжоқ
messagestringжоқ
Нысан өрістері
{
  "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"
    }
  }
}
Сұрақтарыңыз қалды ма? Request ID мен сипаттаманы жіберіңіз — мәселені анықтауға көмектесеміз.Қолдау қызметіне жазу
КіруТіркелуЖеке кабинет
Тарифтер