docs
Dashboard
Dashboard API

Data schemas

Markdown

Dashboard API object fields and types.

Full guide

Dashboard API object fields and their types. omitempty means the field may be absent from the response; it does not permit sending null. PLACEHOLDER strings indicate types, not a real response.

APIKey

The fieldTypeRequiredValidation / description
idintegerno
user_idintegerno
keystringno
namestringno
statusstringno
ip_whitelistarray · items: stringno
ip_blacklistarray · items: stringno
last_used_atstringno; may be null
last_used_ipstringno; may be null
quotanumberno; Key spending limit in USD; 0 means unlimited
quota_usednumberno; Amount used against the key limit, USD
expires_atstringno; Expiry; null means no expiry; may be null
created_atstringno
updated_atstringno
current_concurrencyintegerno
rate_limit_5hnumberno
rate_limit_1dnumberno
rate_limit_7dnumberno
usage_5hnumberno
usage_1dnumberno
usage_7dnumberno
window_5h_startstringno; may be null
window_1d_startstringno; may be null
window_7d_startstringno; may be null
reset_5h_atstringno; may be null
reset_1d_atstringno; may be null
reset_7d_atstringno; may be null
userobject · Userno; may be null
Object fields
{
  "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

The fieldTypeRequiredValidation / description
datestringno
requestsintegerno
input_tokensintegerno
output_tokensintegerno
cache_read_tokensintegerno
cache_write_tokensintegerno
total_tokensintegerno
costnumberno; Cost at the standard rate
actual_costnumberno; Actual charge
Object fields
{
  "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

The fieldTypeRequiredValidation / description
access_tokenstringno
refresh_tokenstringno; Session refresh token
expires_inintegerno; Access token lifetime in seconds
token_typestringno
userobject · Userno; may be null
Object fields
{
  "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

The fieldTypeRequiredValidation / description
api_key_idsarray · items: integer (int64)yesrequired
Object fields
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

The fieldTypeRequiredValidation / description
api_key_idintegerno
today_actual_costnumberno
total_actual_costnumberno
Object fields
{
  "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

The fieldTypeRequiredValidation / description
old_passwordstringyesrequired
new_passwordstringyesrequired,min=6
Object fields
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

The fieldTypeRequiredValidation / description
namestringyesrequired
custom_keystringno; Optional custom key value; may be null
ip_whitelistarray · items: stringno; IP allowlist
ip_blacklistarray · items: stringno; IP blocklist
quotanumberno; Key spending limit in USD; may be null
expires_in_daysintegerno; Validity period in days; may be null
rate_limit_5hnumberno; may be null
rate_limit_1dnumberno; may be null
rate_limit_7dnumberno; may be null
Object fields
{
  "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

The fieldTypeRequiredValidation / description
emailstringyesrequired,email
turnstile_tokenstringno
Object fields
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

The fieldTypeRequiredValidation / description
messagestringno
Object fields
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

The fieldTypeRequiredValidation / description
temp_tokenstringyesrequired
totp_codestringyesrequired,len=6
Object fields
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

The fieldTypeRequiredValidation / description
emailstringyesrequired,email
passwordstringyesrequired
turnstile_tokenstringno
Object fields
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

The fieldTypeRequiredValidation / description
refresh_tokenstringno; Optional: revoke the specified refresh token
Object fields
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

The fieldTypeRequiredValidation / description
messagestringno
Object fields
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

The fieldTypeRequiredValidation / description
turnstile_tokenstringno
Object fields
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

The fieldTypeRequiredValidation / description
idintegerno
namestringno
created_atstringno
last_used_atstringno; may be null
backupbooleanno
Object fields
{
  "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

The fieldTypeRequiredValidation / description
session_tokenstringyesrequired
namestringno
credentialobject · WebAuthn PublicKeyCredential JSONyesrequired
Object fields
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

The fieldTypeRequiredValidation / description
session_tokenstringno
optionsanyno
Object fields
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

The fieldTypeRequiredValidation / description
idintegerno
codestringno
typestringno
valuenumberno
statusstringno
used_byintegerno; may be null
used_atstringno; may be null
created_atstringno
expires_atstringno; may be null
validity_daysintegerno
notesstringno; may be null
userobject · Userno; may be null
Object fields
{
  "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

The fieldTypeRequiredValidation / description
codestringyesrequired
Object fields
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

The fieldTypeRequiredValidation / description
refresh_tokenstringyesrequired
Object fields
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

The fieldTypeRequiredValidation / description
access_tokenstringno
refresh_tokenstringno
expires_inintegerno; Access token lifetime in seconds
token_typestringno
Object fields
{
  "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

The fieldTypeRequiredValidation / description
emailstringyesrequired,email
passwordstringyesrequired,min=6
verify_codestringno
turnstile_tokenstringno
promo_codestringno; Registration promo code
invitation_codestringno; Invitation code
Object fields
{
  "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

The fieldTypeRequiredValidation / description
emailstringyesrequired,email
tokenstringyesrequired
new_passwordstringyesrequired,min=6
Object fields
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

The fieldTypeRequiredValidation / description
messagestringno
Object fields
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

The fieldTypeRequiredValidation / description
messagestringno
Object fields
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

The fieldTypeRequiredValidation / description
emailstringyesrequired,email
turnstile_tokenstringno
Object fields
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

The fieldTypeRequiredValidation / description
messagestringno
countdownintegerno; Waiting time in seconds
Object fields
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

The fieldTypeRequiredValidation / description
requires_2fabooleanno
temp_tokenstringno
user_email_maskedstringno
Object fields
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

The fieldTypeRequiredValidation / description
enabledbooleanno
enabled_atintegerno; Unix timestamp; may be null
feature_enabledbooleanno
Object fields
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

The fieldTypeRequiredValidation / description
namestringno
statusstringnoomitempty,oneof=active inactive
ip_whitelistarray · items: stringno; Allowed IPs: null leaves the list unchanged; an empty array clears it; may be null
ip_blacklistarray · items: stringno; Blocked IPs: null leaves the list unchanged; an empty array clears it; may be null
quotanumberno; Key spending limit in USD; 0 means unlimited; may be null
expires_atstringno; Expiry time in ISO 8601 format; may be null
reset_quotabooleanno; Reset the amount used against the spending limit; may be null
rate_limit_5hnumberno; may be null
rate_limit_1dnumberno; may be null
rate_limit_7dnumberno; may be null
reset_rate_limit_usagebooleanno; Reset usage for spending-window limits; may be null
Object fields
{
  "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

The fieldTypeRequiredValidation / description
usernamestringno; may be null
avatar_urlstringno; may be null
balance_notify_enabledbooleanno; may be null
balance_notify_thresholdnumberno; may be null
Object fields
{
  "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

The fieldTypeRequiredValidation / description
idintegerno
user_idintegerno
api_key_idintegerno
request_idstringno
modelstringno
service_tierstringno; may be null
reasoning_effortstringno; may be null
input_tokensintegerno
output_tokensintegerno
cache_creation_tokensintegerno
cache_read_tokensintegerno
cache_creation_5m_tokensintegerno
cache_creation_1h_tokensintegerno
input_costnumberno
output_costnumberno
cache_creation_costnumberno
cache_read_costnumberno
total_costnumberno
actual_costnumberno
long_context_billing_appliedbooleanno
request_typestringno
streambooleanno
duration_msintegerno; may be null
first_token_msintegerno; may be null
image_countintegerno
image_sizestringno; may be null
image_input_sizestringno; may be null
image_output_sizestringno; may be null
image_input_tokensintegerno
image_input_costnumberno
image_output_tokensintegerno
image_output_costnumberno
image_size_breakdownobject · additionalProperties: integerno
media_typestringno; may be null
ip_addressstringno; may be null
session_idstringno; may be null
created_atstringno
userobject · Userno; may be null
api_keyobject · APIKeyno; may be null
Object fields
{
  "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

The fieldTypeRequiredValidation / description
total_requestsintegerno
total_input_tokensintegerno
total_output_tokensintegerno
total_cache_tokensintegerno
total_cache_creation_tokensintegerno
total_cache_read_tokensintegerno
total_tokensintegerno
total_costnumberno
total_actual_costnumberno
average_duration_msnumberno
endpointsarray · items: EndpointStat · EndpointStatno
Object fields
{
  "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

The fieldTypeRequiredValidation / description
idintegerno
emailstringno
usernamestringno
rolestringno
balancenumberno
frozen_balancenumberno
concurrencyintegerno
statusstringno
last_active_atstringno; may be null
created_atstringno
updated_atstringno
deleted_atstringno; may be null
balance_notify_enabledbooleanno
balance_notify_threshold_typestringno
balance_notify_thresholdnumberno; may be null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryno
total_rechargednumberno
rpm_limitintegerno
api_keysarray · items: APIKey · APIKeyno
Object fields
{
  "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

The fieldTypeRequiredValidation / description
idintegerno
titlestringno
contentstringno
notify_modestringno
starts_atstringno; may be null
ends_atstringno; may be null
read_atstringno; may be null
created_atstringno
updated_atstringno
Object fields
{
  "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

The fieldTypeRequiredValidation / description
total_api_keysintegerno
active_api_keysintegerno
total_requestsintegerno
total_input_tokensintegerno
total_output_tokensintegerno
total_cache_creation_tokensintegerno
total_cache_read_tokensintegerno
total_tokensintegerno
total_costnumberno; Total cost at the standard rate
total_actual_costnumberno; Total actual charges
today_requestsintegerno
today_input_tokensintegerno
today_output_tokensintegerno
today_cache_creation_tokensintegerno
today_cache_read_tokensintegerno
today_tokensintegerno
today_costnumberno; Today’s cost at the standard rate
today_actual_costnumberno; Actual charges today
average_duration_msnumberno
rpmintegerno; Average requests per minute over the last 5 minutes
tpmintegerno; Average tokens per minute over the last 5 minutes
Object fields
{
  "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

The fieldTypeRequiredValidation / description
idintegerno
emailstringno
usernamestringno
rolestringno
balancenumberno
frozen_balancenumberno
concurrencyintegerno
statusstringno
last_active_atstringno; may be null
created_atstringno
updated_atstringno
deleted_atstringno; may be null
balance_notify_enabledbooleanno
balance_notify_threshold_typestringno
balance_notify_thresholdnumberno; may be null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryno
total_rechargednumberno
rpm_limitintegerno
api_keysarray · items: APIKey · APIKeyno
avatar_urlstringno
email_boundbooleanno
Object fields
{
  "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

The fieldTypeRequiredValidation / description
codestringyesrequired
Object fields
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

The fieldTypeRequiredValidation / description
validbooleanno
error_codestringno
Object fields
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

The fieldTypeRequiredValidation / description
codestringyesrequired
Object fields
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

The fieldTypeRequiredValidation / description
validbooleanno
bonus_amountnumberno
error_codestringno
messagestringno
Object fields
{
  "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"
    }
  }
}
Still have questions? Send your Request ID and a description — we'll help you troubleshoot.Contact support
Sign inSign upDashboard
Pricing