tài liệu
API bảng điều khiển

Lược đồ dữ liệu

Markdown

Các trường và kiểu dữ liệu của đối tượng API trang quản lý tài khoản.

Hướng dẫn đầy đủ

Các trường của đối tượng API trang quản lý tài khoản và kiểu dữ liệu tương ứng. omitempty nghĩa là trường có thể không xuất hiện trong phản hồi; không có nghĩa là được phép gửi null. Các chuỗi PLACEHOLDER biểu thị kiểu dữ liệu, không phải phản hồi thật.

APIKey

TrườngKiểuBắt buộcKiểm tra / mô tả
idintegerkhông
user_idintegerkhông
keystringkhông
namestringkhông
statusstringkhông
ip_whitelistarray · items: stringkhông
ip_blacklistarray · items: stringkhông
last_used_atstringkhông; có thể là null
last_used_ipstringkhông; có thể là null
quotanumberkhông; Giới hạn chi tiêu của khóa bằng USD; 0 — không giới hạn
quota_usednumberkhông; Phần giới hạn của khóa đã sử dụng, USD
expires_atstringkhông; Thời hạn hiệu lực; null — không thời hạn; có thể là null
created_atstringkhông
updated_atstringkhông
current_concurrencyintegerkhông
rate_limit_5hnumberkhông
rate_limit_1dnumberkhông
rate_limit_7dnumberkhông
usage_5hnumberkhông
usage_1dnumberkhông
usage_7dnumberkhông
window_5h_startstringkhông; có thể là null
window_1d_startstringkhông; có thể là null
window_7d_startstringkhông; có thể là null
reset_5h_atstringkhông; có thể là null
reset_1d_atstringkhông; có thể là null
reset_7d_atstringkhông; có thể là null
userobject · Userkhông; có thể là null
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
datestringkhông
requestsintegerkhông
input_tokensintegerkhông
output_tokensintegerkhông
cache_read_tokensintegerkhông
cache_write_tokensintegerkhông
total_tokensintegerkhông
costnumberkhông; Chi phí theo giá tiêu chuẩn
actual_costnumberkhông; Số tiền trừ thực tế
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
access_tokenstringkhông
refresh_tokenstringkhông; Token làm mới phiên
expires_inintegerkhông; Thời hạn hiệu lực của token truy cập tính bằng giây
token_typestringkhông
userobject · Userkhông; có thể là null
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
api_key_idsarray · items: integer (int64)córequired
Các trường của đối tượng
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

TrườngKiểuBắt buộcKiểm tra / mô tả
api_key_idintegerkhông
today_actual_costnumberkhông
total_actual_costnumberkhông
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
old_passwordstringcórequired
new_passwordstringcórequired,min=6
Các trường của đối tượng
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
namestringcórequired
custom_keystringkhông; Giá trị khóa tự chọn, không bắt buộc; có thể là null
ip_whitelistarray · items: stringkhông; Danh sách IP được phép
ip_blacklistarray · items: stringkhông; Danh sách IP bị chặn
quotanumberkhông; Giới hạn chi tiêu của khóa bằng USD; có thể là null
expires_in_daysintegerkhông; Thời hạn hiệu lực tính bằng ngày; có thể là null
rate_limit_5hnumberkhông; có thể là null
rate_limit_1dnumberkhông; có thể là null
rate_limit_7dnumberkhông; có thể là null
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
emailstringcórequired,email
turnstile_tokenstringkhông
Các trường của đối tượng
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
messagestringkhông
Các trường của đối tượng
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

TrườngKiểuBắt buộcKiểm tra / mô tả
temp_tokenstringcórequired
totp_codestringcórequired,len=6
Các trường của đối tượng
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
emailstringcórequired,email
passwordstringcórequired
turnstile_tokenstringkhông
Các trường của đối tượng
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
refresh_tokenstringkhông; Tùy chọn: thu hồi token làm mới được chỉ định
Các trường của đối tượng
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
messagestringkhông
Các trường của đối tượng
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
turnstile_tokenstringkhông
Các trường của đối tượng
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

TrườngKiểuBắt buộcKiểm tra / mô tả
idintegerkhông
namestringkhông
created_atstringkhông
last_used_atstringkhông; có thể là null
backupbooleankhông
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
session_tokenstringcórequired
namestringkhông
credentialobject · WebAuthn PublicKeyCredential JSONcórequired
Các trường của đối tượng
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
session_tokenstringkhông
optionsanykhông
Các trường của đối tượng
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

TrườngKiểuBắt buộcKiểm tra / mô tả
idintegerkhông
codestringkhông
typestringkhông
valuenumberkhông
statusstringkhông
used_byintegerkhông; có thể là null
used_atstringkhông; có thể là null
created_atstringkhông
expires_atstringkhông; có thể là null
validity_daysintegerkhông
notesstringkhông; có thể là null
userobject · Userkhông; có thể là null
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
codestringcórequired
Các trường của đối tượng
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
refresh_tokenstringcórequired
Các trường của đối tượng
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
access_tokenstringkhông
refresh_tokenstringkhông
expires_inintegerkhông; Thời hạn hiệu lực của token truy cập tính bằng giây
token_typestringkhông
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
emailstringcórequired,email
passwordstringcórequired,min=6
verify_codestringkhông
turnstile_tokenstringkhông
promo_codestringkhông; Mã khuyến mại khi đăng ký
invitation_codestringkhông; Mã lời mời
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
emailstringcórequired,email
tokenstringcórequired
new_passwordstringcórequired,min=6
Các trường của đối tượng
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
messagestringkhông
Các trường của đối tượng
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
messagestringkhông
Các trường của đối tượng
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
emailstringcórequired,email
turnstile_tokenstringkhông
Các trường của đối tượng
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
messagestringkhông
countdownintegerkhông; Thời gian chờ tính bằng giây
Các trường của đối tượng
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
requires_2fabooleankhông
temp_tokenstringkhông
user_email_maskedstringkhông
Các trường của đối tượng
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
enabledbooleankhông
enabled_atintegerkhông; Dấu thời gian Unix; có thể là null
feature_enabledbooleankhông
Các trường của đối tượng
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
namestringkhông
statusstringkhôngomitempty,oneof=active inactive
ip_whitelistarray · items: stringkhông; IP được phép: null không thay đổi danh sách, mảng rỗng xóa toàn bộ danh sách; có thể là null
ip_blacklistarray · items: stringkhông; IP bị chặn: null không thay đổi danh sách, mảng rỗng xóa toàn bộ danh sách; có thể là null
quotanumberkhông; Giới hạn chi tiêu của khóa bằng USD; 0 — không giới hạn; có thể là null
expires_atstringkhông; Thời điểm hết hiệu lực theo định dạng ISO 8601; có thể là null
reset_quotabooleankhông; Đặt lại phần giới hạn chi tiêu đã sử dụng; có thể là null
rate_limit_5hnumberkhông; có thể là null
rate_limit_1dnumberkhông; có thể là null
rate_limit_7dnumberkhông; có thể là null
reset_rate_limit_usagebooleankhông; Đặt lại mức sử dụng của các giới hạn theo khoảng thời gian; có thể là null
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
usernamestringkhông; có thể là null
avatar_urlstringkhông; có thể là null
balance_notify_enabledbooleankhông; có thể là null
balance_notify_thresholdnumberkhông; có thể là null
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
idintegerkhông
user_idintegerkhông
api_key_idintegerkhông
request_idstringkhông
modelstringkhông
service_tierstringkhông; có thể là null
reasoning_effortstringkhông; có thể là null
input_tokensintegerkhông
output_tokensintegerkhông
cache_creation_tokensintegerkhông
cache_read_tokensintegerkhông
cache_creation_5m_tokensintegerkhông
cache_creation_1h_tokensintegerkhông
input_costnumberkhông
output_costnumberkhông
cache_creation_costnumberkhông
cache_read_costnumberkhông
total_costnumberkhông
actual_costnumberkhông
long_context_billing_appliedbooleankhông
request_typestringkhông
streambooleankhông
duration_msintegerkhông; có thể là null
first_token_msintegerkhông; có thể là null
image_countintegerkhông
image_sizestringkhông; có thể là null
image_input_sizestringkhông; có thể là null
image_output_sizestringkhông; có thể là null
image_input_tokensintegerkhông
image_input_costnumberkhông
image_output_tokensintegerkhông
image_output_costnumberkhông
image_size_breakdownobject · additionalProperties: integerkhông
media_typestringkhông; có thể là null
ip_addressstringkhông; có thể là null
session_idstringkhông; có thể là null
created_atstringkhông
userobject · Userkhông; có thể là null
api_keyobject · APIKeykhông; có thể là null
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
total_requestsintegerkhông
total_input_tokensintegerkhông
total_output_tokensintegerkhông
total_cache_tokensintegerkhông
total_cache_creation_tokensintegerkhông
total_cache_read_tokensintegerkhông
total_tokensintegerkhông
total_costnumberkhông
total_actual_costnumberkhông
average_duration_msnumberkhông
endpointsarray · items: EndpointStat · EndpointStatkhông
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
idintegerkhông
emailstringkhông
usernamestringkhông
rolestringkhông
balancenumberkhông
frozen_balancenumberkhông
concurrencyintegerkhông
statusstringkhông
last_active_atstringkhông; có thể là null
created_atstringkhông
updated_atstringkhông
deleted_atstringkhông; có thể là null
balance_notify_enabledbooleankhông
balance_notify_threshold_typestringkhông
balance_notify_thresholdnumberkhông; có thể là null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrykhông
total_rechargednumberkhông
rpm_limitintegerkhông
api_keysarray · items: APIKey · APIKeykhông
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
idintegerkhông
titlestringkhông
contentstringkhông
notify_modestringkhông
starts_atstringkhông; có thể là null
ends_atstringkhông; có thể là null
read_atstringkhông; có thể là null
created_atstringkhông
updated_atstringkhông
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
total_api_keysintegerkhông
active_api_keysintegerkhông
total_requestsintegerkhông
total_input_tokensintegerkhông
total_output_tokensintegerkhông
total_cache_creation_tokensintegerkhông
total_cache_read_tokensintegerkhông
total_tokensintegerkhông
total_costnumberkhông; Tổng chi phí theo giá tiêu chuẩn
total_actual_costnumberkhông; Tổng số tiền trừ thực tế
today_requestsintegerkhông
today_input_tokensintegerkhông
today_output_tokensintegerkhông
today_cache_creation_tokensintegerkhông
today_cache_read_tokensintegerkhông
today_tokensintegerkhông
today_costnumberkhông; Chi phí hôm nay theo giá tiêu chuẩn
today_actual_costnumberkhông; Số tiền trừ thực tế hôm nay
average_duration_msnumberkhông
rpmintegerkhông; Số yêu cầu trung bình mỗi phút trong 5 phút gần nhất
tpmintegerkhông; Số token trung bình mỗi phút trong 5 phút gần nhất
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
idintegerkhông
emailstringkhông
usernamestringkhông
rolestringkhông
balancenumberkhông
frozen_balancenumberkhông
concurrencyintegerkhông
statusstringkhông
last_active_atstringkhông; có thể là null
created_atstringkhông
updated_atstringkhông
deleted_atstringkhông; có thể là null
balance_notify_enabledbooleankhông
balance_notify_threshold_typestringkhông
balance_notify_thresholdnumberkhông; có thể là null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrykhông
total_rechargednumberkhông
rpm_limitintegerkhông
api_keysarray · items: APIKey · APIKeykhông
avatar_urlstringkhông
email_boundbooleankhông
Các trường của đối tượng
{
  "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

TrườngKiểuBắt buộcKiểm tra / mô tả
codestringcórequired
Các trường của đối tượng
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
validbooleankhông
error_codestringkhông
Các trường của đối tượng
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

TrườngKiểuBắt buộcKiểm tra / mô tả
codestringcórequired
Các trường của đối tượng
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

TrườngKiểuBắt buộcKiểm tra / mô tả
validbooleankhông
bonus_amountnumberkhông
error_codestringkhông
messagestringkhông
Các trường của đối tượng
{
  "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"
    }
  }
}
Còn câu hỏi? Hãy gửi Request ID và mô tả — chúng tôi sẽ giúp tìm hiểu.Liên hệ hỗ trợ