תיעוד
האזור האישי
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 ותיאור — נעזור לברר.פנייה לתמיכה
התחברותהרשמההאזור האישי
תעריפים