ドキュメント
ダッシュボード
ダッシュボード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タイムスタンプ；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と状況の説明をお送りください。調査をお手伝いします。サポートに問い合わせる
ログイン新規登録ダッシュボード
料金