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 и описание — поможем разобраться.Написать в поддержку
ВойтиРегистрацияКабинет
Тарифы