docs
Tableau de bord
API du tableau de bord

Schémas de données

Markdown

Champs et types des objets de l’API de l’espace personnel.

Guide complet

Champs et types des objets de l’API de l’espace personnel. omitempty signifie qu’un champ peut être absent de la réponse ; cela n’autorise pas l’envoi de null. Les chaînes PLACEHOLDER représentent un type, et non une réponse réelle.

APIKey

Le champTypeObligatoireValidation / description
idintegernon
user_idintegernon
keystringnon
namestringnon
statusstringnon
ip_whitelistarray · items: stringnon
ip_blacklistarray · items: stringnon
last_used_atstringnon; peut être null
last_used_ipstringnon; peut être null
quotanumbernon; Plafond de dépenses de la clé en USD ; 0 signifie sans plafond
quota_usednumbernon; Montant dépensé sur le plafond de la clé, en USD
expires_atstringnon; Date d’expiration ; null signifie sans expiration ; peut être null
created_atstringnon
updated_atstringnon
current_concurrencyintegernon
rate_limit_5hnumbernon
rate_limit_1dnumbernon
rate_limit_7dnumbernon
usage_5hnumbernon
usage_1dnumbernon
usage_7dnumbernon
window_5h_startstringnon; peut être null
window_1d_startstringnon; peut être null
window_7d_startstringnon; peut être null
reset_5h_atstringnon; peut être null
reset_1d_atstringnon; peut être null
reset_7d_atstringnon; peut être null
userobject · Usernon; peut être null
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
datestringnon
requestsintegernon
input_tokensintegernon
output_tokensintegernon
cache_read_tokensintegernon
cache_write_tokensintegernon
total_tokensintegernon
costnumbernon; Coût au tarif standard
actual_costnumbernon; Débit réel
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
access_tokenstringnon
refresh_tokenstringnon; Token de renouvellement de session
expires_inintegernon; Durée de validité du token d’accès, en secondes
token_typestringnon
userobject · Usernon; peut être null
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
api_key_idsarray · items: integer (int64)ouirequired
Champs de l’objet
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

Le champTypeObligatoireValidation / description
api_key_idintegernon
today_actual_costnumbernon
total_actual_costnumbernon
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
old_passwordstringouirequired
new_passwordstringouirequired,min=6
Champs de l’objet
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

Le champTypeObligatoireValidation / description
namestringouirequired
custom_keystringnon; Valeur personnalisée facultative de la clé ; peut être null
ip_whitelistarray · items: stringnon; Liste des IP autorisées
ip_blacklistarray · items: stringnon; Liste des IP interdites
quotanumbernon; Plafond de dépenses de la clé en USD ; peut être null
expires_in_daysintegernon; Durée de validité en jours ; peut être null
rate_limit_5hnumbernon; peut être null
rate_limit_1dnumbernon; peut être null
rate_limit_7dnumbernon; peut être null
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
emailstringouirequired,email
turnstile_tokenstringnon
Champs de l’objet
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

Le champTypeObligatoireValidation / description
messagestringnon
Champs de l’objet
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

Le champTypeObligatoireValidation / description
temp_tokenstringouirequired
totp_codestringouirequired,len=6
Champs de l’objet
{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

Le champTypeObligatoireValidation / description
emailstringouirequired,email
passwordstringouirequired
turnstile_tokenstringnon
Champs de l’objet
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

Le champTypeObligatoireValidation / description
refresh_tokenstringnon; Facultatif : révoquer le token de renouvellement indiqué
Champs de l’objet
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

Le champTypeObligatoireValidation / description
messagestringnon
Champs de l’objet
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

Le champTypeObligatoireValidation / description
turnstile_tokenstringnon
Champs de l’objet
{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

Le champTypeObligatoireValidation / description
idintegernon
namestringnon
created_atstringnon
last_used_atstringnon; peut être null
backupbooleannon
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
session_tokenstringouirequired
namestringnon
credentialobject · WebAuthn PublicKeyCredential JSONouirequired
Champs de l’objet
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

Le champTypeObligatoireValidation / description
session_tokenstringnon
optionsanynon
Champs de l’objet
{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

Le champTypeObligatoireValidation / description
idintegernon
codestringnon
typestringnon
valuenumbernon
statusstringnon
used_byintegernon; peut être null
used_atstringnon; peut être null
created_atstringnon
expires_atstringnon; peut être null
validity_daysintegernon
notesstringnon; peut être null
userobject · Usernon; peut être null
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
codestringouirequired
Champs de l’objet
{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

Le champTypeObligatoireValidation / description
refresh_tokenstringouirequired
Champs de l’objet
{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

Le champTypeObligatoireValidation / description
access_tokenstringnon
refresh_tokenstringnon
expires_inintegernon; Durée de validité du token d’accès, en secondes
token_typestringnon
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
emailstringouirequired,email
passwordstringouirequired,min=6
verify_codestringnon
turnstile_tokenstringnon
promo_codestringnon; Code promotionnel d’inscription
invitation_codestringnon; Code d’invitation
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
emailstringouirequired,email
tokenstringouirequired
new_passwordstringouirequired,min=6
Champs de l’objet
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

Le champTypeObligatoireValidation / description
messagestringnon
Champs de l’objet
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

Le champTypeObligatoireValidation / description
messagestringnon
Champs de l’objet
{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

Le champTypeObligatoireValidation / description
emailstringouirequired,email
turnstile_tokenstringnon
Champs de l’objet
{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

Le champTypeObligatoireValidation / description
messagestringnon
countdownintegernon; Délai d’attente en secondes
Champs de l’objet
{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

Le champTypeObligatoireValidation / description
requires_2fabooleannon
temp_tokenstringnon
user_email_maskedstringnon
Champs de l’objet
{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

Le champTypeObligatoireValidation / description
enabledbooleannon
enabled_atintegernon; Unix timestamp ; peut être null
feature_enabledbooleannon
Champs de l’objet
{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

Le champTypeObligatoireValidation / description
namestringnon
statusstringnonomitempty,oneof=active inactive
ip_whitelistarray · items: stringnon; IP autorisées : null ne modifie pas la liste, un tableau vide l’efface ; peut être null
ip_blacklistarray · items: stringnon; IP interdites : null ne modifie pas la liste, un tableau vide l’efface ; peut être null
quotanumbernon; Plafond de dépenses de la clé en USD ; 0 signifie sans plafond ; peut être null
expires_atstringnon; Date et heure d’expiration au format ISO 8601 ; peut être null
reset_quotabooleannon; Remettre à zéro la part dépensée du plafond ; peut être null
rate_limit_5hnumbernon; peut être null
rate_limit_1dnumbernon; peut être null
rate_limit_7dnumbernon; peut être null
reset_rate_limit_usagebooleannon; Remettre à zéro les dépenses comptabilisées par fenêtre ; peut être null
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
usernamestringnon; peut être null
avatar_urlstringnon; peut être null
balance_notify_enabledbooleannon; peut être null
balance_notify_thresholdnumbernon; peut être null
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
idintegernon
user_idintegernon
api_key_idintegernon
request_idstringnon
modelstringnon
service_tierstringnon; peut être null
reasoning_effortstringnon; peut être null
input_tokensintegernon
output_tokensintegernon
cache_creation_tokensintegernon
cache_read_tokensintegernon
cache_creation_5m_tokensintegernon
cache_creation_1h_tokensintegernon
input_costnumbernon
output_costnumbernon
cache_creation_costnumbernon
cache_read_costnumbernon
total_costnumbernon
actual_costnumbernon
long_context_billing_appliedbooleannon
request_typestringnon
streambooleannon
duration_msintegernon; peut être null
first_token_msintegernon; peut être null
image_countintegernon
image_sizestringnon; peut être null
image_input_sizestringnon; peut être null
image_output_sizestringnon; peut être null
image_input_tokensintegernon
image_input_costnumbernon
image_output_tokensintegernon
image_output_costnumbernon
image_size_breakdownobject · additionalProperties: integernon
media_typestringnon; peut être null
ip_addressstringnon; peut être null
session_idstringnon; peut être null
created_atstringnon
userobject · Usernon; peut être null
api_keyobject · APIKeynon; peut être null
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
total_requestsintegernon
total_input_tokensintegernon
total_output_tokensintegernon
total_cache_tokensintegernon
total_cache_creation_tokensintegernon
total_cache_read_tokensintegernon
total_tokensintegernon
total_costnumbernon
total_actual_costnumbernon
average_duration_msnumbernon
endpointsarray · items: EndpointStat · EndpointStatnon
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
idintegernon
emailstringnon
usernamestringnon
rolestringnon
balancenumbernon
frozen_balancenumbernon
concurrencyintegernon
statusstringnon
last_active_atstringnon; peut être null
created_atstringnon
updated_atstringnon
deleted_atstringnon; peut être null
balance_notify_enabledbooleannon
balance_notify_threshold_typestringnon
balance_notify_thresholdnumbernon; peut être null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynon
total_rechargednumbernon
rpm_limitintegernon
api_keysarray · items: APIKey · APIKeynon
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
idintegernon
titlestringnon
contentstringnon
notify_modestringnon
starts_atstringnon; peut être null
ends_atstringnon; peut être null
read_atstringnon; peut être null
created_atstringnon
updated_atstringnon
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
total_api_keysintegernon
active_api_keysintegernon
total_requestsintegernon
total_input_tokensintegernon
total_output_tokensintegernon
total_cache_creation_tokensintegernon
total_cache_read_tokensintegernon
total_tokensintegernon
total_costnumbernon; Coût total au tarif standard
total_actual_costnumbernon; Total réellement débité
today_requestsintegernon
today_input_tokensintegernon
today_output_tokensintegernon
today_cache_creation_tokensintegernon
today_cache_read_tokensintegernon
today_tokensintegernon
today_costnumbernon; Coût du jour au tarif standard
today_actual_costnumbernon; Montant réellement débité aujourd’hui
average_duration_msnumbernon
rpmintegernon; Nombre moyen de requêtes par minute sur les 5 dernières minutes
tpmintegernon; Nombre moyen de tokens par minute sur les 5 dernières minutes
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
idintegernon
emailstringnon
usernamestringnon
rolestringnon
balancenumbernon
frozen_balancenumbernon
concurrencyintegernon
statusstringnon
last_active_atstringnon; peut être null
created_atstringnon
updated_atstringnon
deleted_atstringnon; peut être null
balance_notify_enabledbooleannon
balance_notify_threshold_typestringnon
balance_notify_thresholdnumbernon; peut être null
balance_notify_extra_emailsarray · items: NotifyEmailEntry · NotifyEmailEntrynon
total_rechargednumbernon
rpm_limitintegernon
api_keysarray · items: APIKey · APIKeynon
avatar_urlstringnon
email_boundbooleannon
Champs de l’objet
{
  "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

Le champTypeObligatoireValidation / description
codestringouirequired
Champs de l’objet
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

Le champTypeObligatoireValidation / description
validbooleannon
error_codestringnon
Champs de l’objet
{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

Le champTypeObligatoireValidation / description
codestringouirequired
Champs de l’objet
{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

Le champTypeObligatoireValidation / description
validbooleannon
bonus_amountnumbernon
error_codestringnon
messagestringnon
Champs de l’objet
{
  "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"
    }
  }
}
Encore des questions ? Envoyez le Request ID et une description : nous vous aiderons à comprendre.Contacter l’assistance
Se connecterInscriptionTableau de bord
Tarifs