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 และรายละเอียดมาให้เรา เราจะช่วยตรวจ⁠สอบติดต่อฝ่ายสนับสนุน