dokumentasi
API panel pengguna

Skema data

Markdown

Medan dan jenis objek API panel pengguna.

Panduan lengkap

Medan objek API panel pengguna dan jenisnya. omitempty bermaksud medan boleh tiada dalam respons; ini bukan kebenaran untuk menghantar null. Rentetan PLACEHOLDER menunjukkan jenis, bukan respons sebenar.

APIKey

MedanJenisWajibPengesahan / penerangan
idintegertidak
user_idintegertidak
keystringtidak
namestringtidak
statusstringtidak
ip_whitelistarray · items: stringtidak
ip_blacklistarray · items: stringtidak
last_used_atstringtidak; boleh bernilai null
last_used_ipstringtidak; boleh bernilai null
quotanumbertidak; Had perbelanjaan kunci dalam USD; 0 — tanpa had
quota_usednumbertidak; Amaun had kunci yang telah dibelanjakan, USD
expires_atstringtidak; Tempoh sah; null — tanpa tarikh luput; boleh bernilai null
created_atstringtidak
updated_atstringtidak
current_concurrencyintegertidak
rate_limit_5hnumbertidak
rate_limit_1dnumbertidak
rate_limit_7dnumbertidak
usage_5hnumbertidak
usage_1dnumbertidak
usage_7dnumbertidak
window_5h_startstringtidak; boleh bernilai null
window_1d_startstringtidak; boleh bernilai null
window_7d_startstringtidak; boleh bernilai null
reset_5h_atstringtidak; boleh bernilai null
reset_1d_atstringtidak; boleh bernilai null
reset_7d_atstringtidak; boleh bernilai null
userobject · Usertidak; boleh bernilai null
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
datestringtidak
requestsintegertidak
input_tokensintegertidak
output_tokensintegertidak
cache_read_tokensintegertidak
cache_write_tokensintegertidak
total_tokensintegertidak
costnumbertidak; Kos pada harga standard
actual_costnumbertidak; Caj sebenar
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
access_tokenstringtidak
refresh_tokenstringtidak; Token pembaharuan sesi
expires_inintegertidak; Tempoh sah token akses dalam saat
token_typestringtidak
userobject · Usertidak; boleh bernilai null
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
api_key_idsarray · items: integer (int64)yarequired
Medan objek
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

MedanJenisWajibPengesahan / penerangan
api_key_idintegertidak
today_actual_costnumbertidak
total_actual_costnumbertidak
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
old_passwordstringyarequired
new_passwordstringyarequired,min=6
Medan objek
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

MedanJenisWajibPengesahan / penerangan
namestringyarequired
custom_keystringtidak; Nilai kunci tersuai pilihan; boleh bernilai null
ip_whitelistarray · items: stringtidak; Senarai IP yang dibenarkan
ip_blacklistarray · items: stringtidak; Senarai IP yang disekat
quotanumbertidak; Had perbelanjaan kunci dalam USD; boleh bernilai null
expires_in_daysintegertidak; Tempoh sah dalam hari; boleh bernilai null
rate_limit_5hnumbertidak; boleh bernilai null
rate_limit_1dnumbertidak; boleh bernilai null
rate_limit_7dnumbertidak; boleh bernilai null
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
emailstringyarequired,email
turnstile_tokenstringtidak
Medan objek
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

MedanJenisWajibPengesahan / penerangan
messagestringtidak
Medan objek
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

MedanJenisWajibPengesahan / penerangan
temp_tokenstringyarequired
totp_codestringyarequired,len=6
Medan objek
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

MedanJenisWajibPengesahan / penerangan
emailstringyarequired,email
passwordstringyarequired
turnstile_tokenstringtidak
Medan objek
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

MedanJenisWajibPengesahan / penerangan
refresh_tokenstringtidak; Pilihan: batalkan token pembaharuan yang dinyatakan
Medan objek
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

MedanJenisWajibPengesahan / penerangan
messagestringtidak
Medan objek
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

MedanJenisWajibPengesahan / penerangan
turnstile_tokenstringtidak
Medan objek
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

MedanJenisWajibPengesahan / penerangan
idintegertidak
namestringtidak
created_atstringtidak
last_used_atstringtidak; boleh bernilai null
backupbooleantidak
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
session_tokenstringyarequired
namestringtidak
credentialobject · WebAuthn PublicKeyCredential JSONyarequired
Medan objek
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

MedanJenisWajibPengesahan / penerangan
session_tokenstringtidak
optionsanytidak
Medan objek
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

MedanJenisWajibPengesahan / penerangan
idintegertidak
codestringtidak
typestringtidak
valuenumbertidak
statusstringtidak
used_byintegertidak; boleh bernilai null
used_atstringtidak; boleh bernilai null
created_atstringtidak
expires_atstringtidak; boleh bernilai null
validity_daysintegertidak
notesstringtidak; boleh bernilai null
userobject · Usertidak; boleh bernilai null
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
codestringyarequired
Medan objek
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

MedanJenisWajibPengesahan / penerangan
refresh_tokenstringyarequired
Medan objek
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

MedanJenisWajibPengesahan / penerangan
access_tokenstringtidak
refresh_tokenstringtidak
expires_inintegertidak; Tempoh sah token akses dalam saat
token_typestringtidak
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
emailstringyarequired,email
passwordstringyarequired,min=6
verify_codestringtidak
turnstile_tokenstringtidak
promo_codestringtidak; Kod promosi pendaftaran
invitation_codestringtidak; Kod jemputan
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
emailstringyarequired,email
tokenstringyarequired
new_passwordstringyarequired,min=6
Medan objek
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

MedanJenisWajibPengesahan / penerangan
messagestringtidak
Medan objek
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

MedanJenisWajibPengesahan / penerangan
messagestringtidak
Medan objek
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

MedanJenisWajibPengesahan / penerangan
emailstringyarequired,email
turnstile_tokenstringtidak
Medan objek
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

MedanJenisWajibPengesahan / penerangan
messagestringtidak
countdownintegertidak; Masa menunggu dalam saat
Medan objek
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

MedanJenisWajibPengesahan / penerangan
requires_2fabooleantidak
temp_tokenstringtidak
user_email_maskedstringtidak
Medan objek
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

MedanJenisWajibPengesahan / penerangan
enabledbooleantidak
enabled_atintegertidak; Unix timestamp; boleh bernilai null
feature_enabledbooleantidak
Medan objek
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

MedanJenisWajibPengesahan / penerangan
namestringtidak
statusstringtidakomitempty,oneof=active inactive
ip_whitelistarray · items: stringtidak; IP yang dibenarkan: null tidak mengubah senarai, tatasusunan kosong mengosongkannya; boleh bernilai null
ip_blacklistarray · items: stringtidak; IP yang disekat: null tidak mengubah senarai, tatasusunan kosong mengosongkannya; boleh bernilai null
quotanumbertidak; Had perbelanjaan kunci dalam USD; 0 — tanpa had; boleh bernilai null
expires_atstringtidak; Masa tamat tempoh dalam format ISO 8601; boleh bernilai null
reset_quotabooleantidak; Tetapkan semula bahagian had perbelanjaan yang sudah digunakan; boleh bernilai null
rate_limit_5hnumbertidak; boleh bernilai null
rate_limit_1dnumbertidak; boleh bernilai null
rate_limit_7dnumbertidak; boleh bernilai null
reset_rate_limit_usagebooleantidak; Tetapkan semula penggunaan had mengikut tetingkap masa; boleh bernilai null
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
usernamestringtidak; boleh bernilai null
avatar_urlstringtidak; boleh bernilai null
balance_notify_enabledbooleantidak; boleh bernilai null
balance_notify_thresholdnumbertidak; boleh bernilai null
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
idintegertidak
user_idintegertidak
api_key_idintegertidak
request_idstringtidak
modelstringtidak
service_tierstringtidak; boleh bernilai null
reasoning_effortstringtidak; boleh bernilai null
input_tokensintegertidak
output_tokensintegertidak
cache_creation_tokensintegertidak
cache_read_tokensintegertidak
cache_creation_5m_tokensintegertidak
cache_creation_1h_tokensintegertidak
input_costnumbertidak
output_costnumbertidak
cache_creation_costnumbertidak
cache_read_costnumbertidak
total_costnumbertidak
actual_costnumbertidak
long_context_billing_appliedbooleantidak
request_typestringtidak
streambooleantidak
duration_msintegertidak; boleh bernilai null
first_token_msintegertidak; boleh bernilai null
image_countintegertidak
image_sizestringtidak; boleh bernilai null
image_input_sizestringtidak; boleh bernilai null
image_output_sizestringtidak; boleh bernilai null
image_input_tokensintegertidak
image_input_costnumbertidak
image_output_tokensintegertidak
image_output_costnumbertidak
image_size_breakdownobject · additionalProperties: integertidak
media_typestringtidak; boleh bernilai null
ip_addressstringtidak; boleh bernilai null
session_idstringtidak; boleh bernilai null
created_atstringtidak
userobject · Usertidak; boleh bernilai null
api_keyobject · APIKeytidak; boleh bernilai null
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
total_requestsintegertidak
total_input_tokensintegertidak
total_output_tokensintegertidak
total_cache_tokensintegertidak
total_cache_creation_tokensintegertidak
total_cache_read_tokensintegertidak
total_tokensintegertidak
total_costnumbertidak
total_actual_costnumbertidak
average_duration_msnumbertidak
endpointsarray · items: EndpointStat · EndpointStattidak
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
idintegertidak
emailstringtidak
usernamestringtidak
rolestringtidak
balancenumbertidak
frozen_balancenumbertidak
concurrencyintegertidak
statusstringtidak
last_active_atstringtidak; boleh bernilai null
created_atstringtidak
updated_atstringtidak
deleted_atstringtidak; boleh bernilai null
balance_notify_enabledbooleantidak
balance_notify_threshold_typestringtidak
balance_notify_thresholdnumbertidak; boleh bernilai null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrytidak
total_rechargednumbertidak
rpm_limitintegertidak
api_keysarray · items: APIKey · APIKeytidak
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
idintegertidak
titlestringtidak
contentstringtidak
notify_modestringtidak
starts_atstringtidak; boleh bernilai null
ends_atstringtidak; boleh bernilai null
read_atstringtidak; boleh bernilai null
created_atstringtidak
updated_atstringtidak
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
total_api_keysintegertidak
active_api_keysintegertidak
total_requestsintegertidak
total_input_tokensintegertidak
total_output_tokensintegertidak
total_cache_creation_tokensintegertidak
total_cache_read_tokensintegertidak
total_tokensintegertidak
total_costnumbertidak; Jumlah kos pada harga standard
total_actual_costnumbertidak; Jumlah caj sebenar
today_requestsintegertidak
today_input_tokensintegertidak
today_output_tokensintegertidak
today_cache_creation_tokensintegertidak
today_cache_read_tokensintegertidak
today_tokensintegertidak
today_costnumbertidak; Kos hari ini pada harga standard
today_actual_costnumbertidak; Caj sebenar hari ini
average_duration_msnumbertidak
rpmintegertidak; Purata bilangan permintaan seminit sepanjang 5 minit terakhir
tpmintegertidak; Purata bilangan token seminit sepanjang 5 minit terakhir
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
idintegertidak
emailstringtidak
usernamestringtidak
rolestringtidak
balancenumbertidak
frozen_balancenumbertidak
concurrencyintegertidak
statusstringtidak
last_active_atstringtidak; boleh bernilai null
created_atstringtidak
updated_atstringtidak
deleted_atstringtidak; boleh bernilai null
balance_notify_enabledbooleantidak
balance_notify_threshold_typestringtidak
balance_notify_thresholdnumbertidak; boleh bernilai null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrytidak
total_rechargednumbertidak
rpm_limitintegertidak
api_keysarray · items: APIKey · APIKeytidak
avatar_urlstringtidak
email_boundbooleantidak
Medan objek
{
  "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

MedanJenisWajibPengesahan / penerangan
codestringyarequired
Medan objek
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

MedanJenisWajibPengesahan / penerangan
validbooleantidak
error_codestringtidak
Medan objek
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

MedanJenisWajibPengesahan / penerangan
codestringyarequired
Medan objek
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

MedanJenisWajibPengesahan / penerangan
validbooleantidak
bonus_amountnumbertidak
error_codestringtidak
messagestringtidak
Medan objek
{
  "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"
    }
  }
}
Masih ada soalan? Hantar Request ID dan penerangannya — kami akan membantu menyiasatnya.Hubungi sokongan