docs
Panel de control
API del panel de control

Esquemas de datos

Markdown

Campos y tipos de los objetos de la API del panel de control.

Guía completa

Campos de los objetos de la API del panel de control y sus tipos. omitempty significa que el campo puede faltar en la respuesta; no permite enviar null. Las cadenas PLACEHOLDER indican el tipo, no una respuesta real.

APIKey

El campo TipoObligatorioValidación / descripción
idintegerno
user_idintegerno
keystringno
namestringno
statusstringno
ip_whitelistarray · items: stringno
ip_blacklistarray · items: stringno
last_used_atstringno; puede ser null
last_used_ipstringno; puede ser null
quotanumberno; Límite de gasto de la clave en USD; 0 significa sin límite
quota_usednumberno; Parte gastada del límite de la clave, USD
expires_atstringno; Vigencia; null significa sin caducidad; puede ser 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; puede ser null
window_1d_startstringno; puede ser null
window_7d_startstringno; puede ser null
reset_5h_atstringno; puede ser null
reset_1d_atstringno; puede ser null
reset_7d_atstringno; puede ser null
userobject · Userno; puede ser null
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
datestringno
requestsintegerno
input_tokensintegerno
output_tokensintegerno
cache_read_tokensintegerno
cache_write_tokensintegerno
total_tokensintegerno
costnumberno; Coste al precio estándar
actual_costnumberno; Cargo real
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
access_tokenstringno
refresh_tokenstringno; Token de actualización de la sesión
expires_inintegerno; Vigencia del token de acceso en segundos
token_typestringno
userobject · Userno; puede ser null
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
api_key_idsarray · items: integer (int64)sírequired
Campos del objeto
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

El campo TipoObligatorioValidación / descripción
api_key_idintegerno
today_actual_costnumberno
total_actual_costnumberno
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
old_passwordstringsírequired
new_passwordstringsírequired,min=6
Campos del objeto
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

El campo TipoObligatorioValidación / descripción
namestringsírequired
custom_keystringno; Valor de clave personalizado opcional; puede ser null
ip_whitelistarray · items: stringno; Lista de IP permitidas
ip_blacklistarray · items: stringno; Lista de IP bloqueadas
quotanumberno; Límite de gasto de la clave en USD; puede ser null
expires_in_daysintegerno; Vigencia en días; puede ser null
rate_limit_5hnumberno; puede ser null
rate_limit_1dnumberno; puede ser null
rate_limit_7dnumberno; puede ser null
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
emailstringsírequired,email
turnstile_tokenstringno
Campos del objeto
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

El campo TipoObligatorioValidación / descripción
messagestringno
Campos del objeto
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

El campo TipoObligatorioValidación / descripción
temp_tokenstringsírequired
totp_codestringsírequired,len=6
Campos del objeto
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

El campo TipoObligatorioValidación / descripción
emailstringsírequired,email
passwordstringsírequired
turnstile_tokenstringno
Campos del objeto
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

El campo TipoObligatorioValidación / descripción
refresh_tokenstringno; Opcional: revocar el token de actualización indicado
Campos del objeto
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

El campo TipoObligatorioValidación / descripción
messagestringno
Campos del objeto
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

El campo TipoObligatorioValidación / descripción
turnstile_tokenstringno
Campos del objeto
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

El campo TipoObligatorioValidación / descripción
idintegerno
namestringno
created_atstringno
last_used_atstringno; puede ser null
backupbooleanno
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
session_tokenstringsírequired
namestringno
credentialobject · WebAuthn PublicKeyCredential JSONsírequired
Campos del objeto
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

El campo TipoObligatorioValidación / descripción
session_tokenstringno
optionsanyno
Campos del objeto
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

El campo TipoObligatorioValidación / descripción
idintegerno
codestringno
typestringno
valuenumberno
statusstringno
used_byintegerno; puede ser null
used_atstringno; puede ser null
created_atstringno
expires_atstringno; puede ser null
validity_daysintegerno
notesstringno; puede ser null
userobject · Userno; puede ser null
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
codestringsírequired
Campos del objeto
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

El campo TipoObligatorioValidación / descripción
refresh_tokenstringsírequired
Campos del objeto
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

El campo TipoObligatorioValidación / descripción
access_tokenstringno
refresh_tokenstringno
expires_inintegerno; Vigencia del token de acceso en segundos
token_typestringno
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
emailstringsírequired,email
passwordstringsírequired,min=6
verify_codestringno
turnstile_tokenstringno
promo_codestringno; Código promocional de registro
invitation_codestringno; Código de invitación
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
emailstringsírequired,email
tokenstringsírequired
new_passwordstringsírequired,min=6
Campos del objeto
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

El campo TipoObligatorioValidación / descripción
messagestringno
Campos del objeto
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

El campo TipoObligatorioValidación / descripción
messagestringno
Campos del objeto
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

El campo TipoObligatorioValidación / descripción
emailstringsírequired,email
turnstile_tokenstringno
Campos del objeto
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

El campo TipoObligatorioValidación / descripción
messagestringno
countdownintegerno; Tiempo de espera en segundos
Campos del objeto
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

El campo TipoObligatorioValidación / descripción
requires_2fabooleanno
temp_tokenstringno
user_email_maskedstringno
Campos del objeto
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

El campo TipoObligatorioValidación / descripción
enabledbooleanno
enabled_atintegerno; Marca de tiempo Unix; puede ser null
feature_enabledbooleanno
Campos del objeto
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

El campo TipoObligatorioValidación / descripción
namestringno
statusstringnoomitempty,oneof=active inactive
ip_whitelistarray · items: stringno; IP permitidas: null no cambia la lista y un array vacío la borra; puede ser null
ip_blacklistarray · items: stringno; IP bloqueadas: null no cambia la lista y un array vacío la borra; puede ser null
quotanumberno; Límite de gasto de la clave en USD; 0 significa sin límite; puede ser null
expires_atstringno; Fecha de caducidad en formato ISO 8601; puede ser null
reset_quotabooleanno; Reiniciar la parte gastada del límite de gasto; puede ser null
rate_limit_5hnumberno; puede ser null
rate_limit_1dnumberno; puede ser null
rate_limit_7dnumberno; puede ser null
reset_rate_limit_usagebooleanno; Reiniciar el gasto acumulado en los límites por periodos; puede ser null
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
usernamestringno; puede ser null
avatar_urlstringno; puede ser null
balance_notify_enabledbooleanno; puede ser null
balance_notify_thresholdnumberno; puede ser null
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
idintegerno
user_idintegerno
api_key_idintegerno
request_idstringno
modelstringno
service_tierstringno; puede ser null
reasoning_effortstringno; puede ser 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; puede ser null
first_token_msintegerno; puede ser null
image_countintegerno
image_sizestringno; puede ser null
image_input_sizestringno; puede ser null
image_output_sizestringno; puede ser null
image_input_tokensintegerno
image_input_costnumberno
image_output_tokensintegerno
image_output_costnumberno
image_size_breakdownobject · additionalProperties: integerno
media_typestringno; puede ser null
ip_addressstringno; puede ser null
session_idstringno; puede ser null
created_atstringno
userobject · Userno; puede ser null
api_keyobject · APIKeyno; puede ser null
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
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
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
idintegerno
emailstringno
usernamestringno
rolestringno
balancenumberno
frozen_balancenumberno
concurrencyintegerno
statusstringno
last_active_atstringno; puede ser null
created_atstringno
updated_atstringno
deleted_atstringno; puede ser null
balance_notify_enabledbooleanno
balance_notify_threshold_typestringno
balance_notify_thresholdnumberno; puede ser null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryno
total_rechargednumberno
rpm_limitintegerno
api_keysarray · items: APIKey · APIKeyno
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
idintegerno
titlestringno
contentstringno
notify_modestringno
starts_atstringno; puede ser null
ends_atstringno; puede ser null
read_atstringno; puede ser null
created_atstringno
updated_atstringno
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
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; Coste total al precio estándar
total_actual_costnumberno; Cargo real total
today_requestsintegerno
today_input_tokensintegerno
today_output_tokensintegerno
today_cache_creation_tokensintegerno
today_cache_read_tokensintegerno
today_tokensintegerno
today_costnumberno; Coste de hoy al precio estándar
today_actual_costnumberno; Cargo real de hoy
average_duration_msnumberno
rpmintegerno; Promedio de solicitudes por minuto en los últimos 5 minutos
tpmintegerno; Promedio de tokens por minuto en los últimos 5 minutos
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
idintegerno
emailstringno
usernamestringno
rolestringno
balancenumberno
frozen_balancenumberno
concurrencyintegerno
statusstringno
last_active_atstringno; puede ser null
created_atstringno
updated_atstringno
deleted_atstringno; puede ser null
balance_notify_enabledbooleanno
balance_notify_threshold_typestringno
balance_notify_thresholdnumberno; puede ser null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntryno
total_rechargednumberno
rpm_limitintegerno
api_keysarray · items: APIKey · APIKeyno
avatar_urlstringno
email_boundbooleanno
Campos del objeto
{
  "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

El campo TipoObligatorioValidación / descripción
codestringsírequired
Campos del objeto
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

El campo TipoObligatorioValidación / descripción
validbooleanno
error_codestringno
Campos del objeto
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

El campo TipoObligatorioValidación / descripción
codestringsírequired
Campos del objeto
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

El campo TipoObligatorioValidación / descripción
validbooleanno
bonus_amountnumberno
error_codestringno
messagestringno
Campos del objeto
{
  "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"
    }
  }
}
¿Tienes alguna pregunta? Envíanos el Request ID y una descripción; te ayudaremos a resolverla.Contactar con soporte
Iniciar sesiónRegistrarsePanel de control
Planes