Esquemas de dados

Campos e tipos dos objetos da API da área pessoal.

Guia completo

Campos dos objetos da API da área pessoal e respetivos tipos. omitempty significa que o campo pode estar ausente da resposta; não autoriza o envio de null. As cadeias PLACEHOLDER indicam o tipo, e não uma resposta real.

APIKey

O campo	Tipo	Obrigatório	Validação / descrição
`id`	`integer`	não
`user_id`	`integer`	não
`key`	`string`	não
`name`	`string`	não
`status`	`string`	não
`ip_whitelist`	`array` · `items: string`	não
`ip_blacklist`	`array` · `items: string`	não
`last_used_at`	`string`	não	; pode ser null
`last_used_ip`	`string`	não	; pode ser null
`quota`	`number`	não	; Limite de despesas da chave em USD; 0 — sem limite
`quota_used`	`number`	não	; Parte utilizada do limite da chave, USD
`expires_at`	`string`	não	; Prazo de validade; null — sem expiração; pode ser null
`created_at`	`string`	não
`updated_at`	`string`	não
`current_concurrency`	`integer`	não
`rate_limit_5h`	`number`	não
`rate_limit_1d`	`number`	não
`rate_limit_7d`	`number`	não
`usage_5h`	`number`	não
`usage_1d`	`number`	não
`usage_7d`	`number`	não
`window_5h_start`	`string`	não	; pode ser null
`window_1d_start`	`string`	não	; pode ser null
`window_7d_start`	`string`	não	; pode ser null
`reset_5h_at`	`string`	não	; pode ser null
`reset_1d_at`	`string`	não	; pode ser null
`reset_7d_at`	`string`	não	; pode ser null
`user`	object · User	não	; pode ser null

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`date`	`string`	não
`requests`	`integer`	não
`input_tokens`	`integer`	não
`output_tokens`	`integer`	não
`cache_read_tokens`	`integer`	não
`cache_write_tokens`	`integer`	não
`total_tokens`	`integer`	não
`cost`	`number`	não	; Custo ao preço normal
`actual_cost`	`number`	não	; Débito efetivo

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`access_token`	`string`	não
`refresh_token`	`string`	não	; Token de atualização da sessão
`expires_in`	`integer`	não	; Prazo de validade do token de acesso em segundos
`token_type`	`string`	não
`user`	object · User	não	; pode ser null

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`api_key_ids`	`array` · `items: integer (int64)`	sim	required

Campos do objeto

{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}

BatchAPIKeyUsageStats

O campo	Tipo	Obrigatório
`api_key_id`	`integer`	não
`today_actual_cost`	`number`	não
`total_actual_cost`	`number`	não

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`old_password`	`string`	sim	required
`new_password`	`string`	sim	required,min=6

Campos do objeto

{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

CreateAPIKeyRequest

O campo	Tipo	Obrigatório	Validação / descrição
`name`	`string`	sim	required
`custom_key`	`string`	não	; Valor personalizado opcional da chave; pode ser null
`ip_whitelist`	`array` · `items: string`	não	; Lista de IP permitidos
`ip_blacklist`	`array` · `items: string`	não	; Lista de IP bloqueados
`quota`	`number`	não	; Limite de despesas da chave em USD; pode ser null
`expires_in_days`	`integer`	não	; Prazo de validade em dias; pode ser null
`rate_limit_5h`	`number`	não	; pode ser null
`rate_limit_1d`	`number`	não	; pode ser null
`rate_limit_7d`	`number`	não	; pode ser null

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`email`	`string`	sim	required,email
`turnstile_token`	`string`	não

Campos do objeto

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

ForgotPasswordResponse

O campo	Tipo	Obrigatório	Validação / descrição
`message`	`string`	não

Campos do objeto

{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

Login2FARequest

O campo	Tipo	Obrigatório	Validação / descrição
`temp_token`	`string`	sim	required
`totp_code`	`string`	sim	required,len=6

Campos do objeto

{
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "totp_code": "PLACEHOLDER_TOTP_CODE (string)"
}

LoginRequest

O campo	Tipo	Obrigatório	Validação / descrição
`email`	`string`	sim	required,email
`password`	`string`	sim	required
`turnstile_token`	`string`	não

Campos do objeto

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "password": "PLACEHOLDER_PASSWORD (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

LogoutRequest

O campo	Tipo	Obrigatório	Validação / descrição
`refresh_token`	`string`	não	; Opcional: revogar o token de atualização indicado

Campos do objeto

{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

LogoutResponse

O campo	Tipo	Obrigatório	Validação / descrição
`message`	`string`	não

Campos do objeto

{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

PasskeyBeginLoginRequest

O campo	Tipo	Obrigatório	Validação / descrição
`turnstile_token`	`string`	não

Campos do objeto

{
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

PasskeyCredentialSummary

O campo	Tipo	Obrigatório	Validação / descrição
`id`	`integer`	não
`name`	`string`	não
`created_at`	`string`	não
`last_used_at`	`string`	não	; pode ser null
`backup`	`boolean`	não

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`session_token`	`string`	sim	required
`name`	`string`	não
`credential`	`object` · `WebAuthn PublicKeyCredential JSON`	sim	required

Campos do objeto

{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "name": "PLACEHOLDER_NAME (string)",
  "credential": "PLACEHOLDER_CREDENTIAL (object)"
}

PasskeyOptionsResponse

O campo	Tipo	Obrigatório	Validação / descrição
`session_token`	`string`	não
`options`	`any`	não

Campos do objeto

{
  "session_token": "PLACEHOLDER_SESSION_TOKEN (string)",
  "options": "PLACEHOLDER_OPTIONS (any)"
}

RedeemCode

O campo	Tipo	Obrigatório	Validação / descrição
`id`	`integer`	não
`code`	`string`	não
`type`	`string`	não
`value`	`number`	não
`status`	`string`	não
`used_by`	`integer`	não	; pode ser null
`used_at`	`string`	não	; pode ser null
`created_at`	`string`	não
`expires_at`	`string`	não	; pode ser null
`validity_days`	`integer`	não
`notes`	`string`	não	; pode ser null
`user`	object · User	não	; pode ser null

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`code`	`string`	sim	required

Campos do objeto

{
  "code": "PLACEHOLDER_CODE (string)"
}

RefreshTokenRequest

O campo	Tipo	Obrigatório	Validação / descrição
`refresh_token`	`string`	sim	required

Campos do objeto

{
  "refresh_token": "PLACEHOLDER_REFRESH_TOKEN (string)"
}

RefreshTokenResponse

O campo	Tipo	Obrigatório	Validação / descrição
`access_token`	`string`	não
`refresh_token`	`string`	não
`expires_in`	`integer`	não	; Prazo de validade do token de acesso em segundos
`token_type`	`string`	não

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`email`	`string`	sim	required,email
`password`	`string`	sim	required,min=6
`verify_code`	`string`	não
`turnstile_token`	`string`	não
`promo_code`	`string`	não	; Código promocional de registo
`invitation_code`	`string`	não	; Código de convite

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`email`	`string`	sim	required,email
`token`	`string`	sim	required
`new_password`	`string`	sim	required,min=6

Campos do objeto

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "token": "PLACEHOLDER_TOKEN (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}

ResetPasswordResponse

O campo	Tipo	Obrigatório	Validação / descrição
`message`	`string`	não

Campos do objeto

{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

RevokeAllSessionsResponse

O campo	Tipo	Obrigatório	Validação / descrição
`message`	`string`	não

Campos do objeto

{
  "message": "PLACEHOLDER_MESSAGE (string)"
}

SendVerifyCodeRequest

O campo	Tipo	Obrigatório	Validação / descrição
`email`	`string`	sim	required,email
`turnstile_token`	`string`	não

Campos do objeto

{
  "email": "PLACEHOLDER_EMAIL (string)",
  "turnstile_token": "PLACEHOLDER_TURNSTILE_TOKEN (string)"
}

SendVerifyCodeResponse

O campo	Tipo	Obrigatório	Validação / descrição
`message`	`string`	não
`countdown`	`integer`	não	; Tempo de espera em segundos

Campos do objeto

{
  "message": "PLACEHOLDER_MESSAGE (string)",
  "countdown": "PLACEHOLDER_COUNTDOWN (integer)"
}

TotpLoginResponse

O campo	Tipo	Obrigatório
`requires_2fa`	`boolean`	não
`temp_token`	`string`	não
`user_email_masked`	`string`	não

Campos do objeto

{
  "requires_2fa": "PLACEHOLDER_REQUIRES_2FA (boolean)",
  "temp_token": "PLACEHOLDER_TEMP_TOKEN (string)",
  "user_email_masked": "PLACEHOLDER_USER_EMAIL_MASKED (string)"
}

TotpStatusResponse

O campo	Tipo	Obrigatório	Validação / descrição
`enabled`	`boolean`	não
`enabled_at`	`integer`	não	; Unix timestamp; pode ser null
`feature_enabled`	`boolean`	não

Campos do objeto

{
  "enabled": "PLACEHOLDER_ENABLED (boolean)",
  "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
  "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
}

UpdateAPIKeyRequest

O campo	Tipo	Obrigatório	Validação / descrição
`name`	`string`	não
`status`	`string`	não	omitempty,oneof=active inactive
`ip_whitelist`	`array` · `items: string`	não	; IP permitidos: null não altera a lista, um array vazio limpa-a; pode ser null
`ip_blacklist`	`array` · `items: string`	não	; IP bloqueados: null não altera a lista, um array vazio limpa-a; pode ser null
`quota`	`number`	não	; Limite de despesas da chave em USD; 0 — sem limite; pode ser null
`expires_at`	`string`	não	; Data e hora de expiração no formato ISO 8601; pode ser null
`reset_quota`	`boolean`	não	; Repor a parte utilizada do limite de despesas; pode ser null
`rate_limit_5h`	`number`	não	; pode ser null
`rate_limit_1d`	`number`	não	; pode ser null
`rate_limit_7d`	`number`	não	; pode ser null
`reset_rate_limit_usage`	`boolean`	não	; Repor o consumo dos limites por janela; pode ser null

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`username`	`string`	não	; pode ser null
`avatar_url`	`string`	não	; pode ser null
`balance_notify_enabled`	`boolean`	não	; pode ser null
`balance_notify_threshold`	`number`	não	; pode ser null

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`id`	`integer`	não
`user_id`	`integer`	não
`api_key_id`	`integer`	não
`request_id`	`string`	não
`model`	`string`	não
`service_tier`	`string`	não	; pode ser null
`reasoning_effort`	`string`	não	; pode ser null
`input_tokens`	`integer`	não
`output_tokens`	`integer`	não
`cache_creation_tokens`	`integer`	não
`cache_read_tokens`	`integer`	não
`cache_creation_5m_tokens`	`integer`	não
`cache_creation_1h_tokens`	`integer`	não
`input_cost`	`number`	não
`output_cost`	`number`	não
`cache_creation_cost`	`number`	não
`cache_read_cost`	`number`	não
`total_cost`	`number`	não
`actual_cost`	`number`	não
`long_context_billing_applied`	`boolean`	não
`request_type`	`string`	não
`stream`	`boolean`	não
`duration_ms`	`integer`	não	; pode ser null
`first_token_ms`	`integer`	não	; pode ser null
`image_count`	`integer`	não
`image_size`	`string`	não	; pode ser null
`image_input_size`	`string`	não	; pode ser null
`image_output_size`	`string`	não	; pode ser null
`image_input_tokens`	`integer`	não
`image_input_cost`	`number`	não
`image_output_tokens`	`integer`	não
`image_output_cost`	`number`	não
`image_size_breakdown`	`object` · `additionalProperties: integer`	não
`media_type`	`string`	não	; pode ser null
`ip_address`	`string`	não	; pode ser null
`session_id`	`string`	não	; pode ser null
`created_at`	`string`	não
`user`	object · User	não	; pode ser null
`api_key`	object · APIKey	não	; pode ser null

Campos do 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

O campo	Tipo	Obrigatório
`total_requests`	`integer`	não
`total_input_tokens`	`integer`	não
`total_output_tokens`	`integer`	não
`total_cache_tokens`	`integer`	não
`total_cache_creation_tokens`	`integer`	não
`total_cache_read_tokens`	`integer`	não
`total_tokens`	`integer`	não
`total_cost`	`number`	não
`total_actual_cost`	`number`	não
`average_duration_ms`	`number`	não
`endpoints`	`array` · `items: EndpointStat` · EndpointStat	não

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`id`	`integer`	não
`email`	`string`	não
`username`	`string`	não
`role`	`string`	não
`balance`	`number`	não
`frozen_balance`	`number`	não
`concurrency`	`integer`	não
`status`	`string`	não
`last_active_at`	`string`	não	; pode ser null
`created_at`	`string`	não
`updated_at`	`string`	não
`deleted_at`	`string`	não	; pode ser null
`balance_notify_enabled`	`boolean`	não
`balance_notify_threshold_type`	`string`	não
`balance_notify_threshold`	`number`	não	; pode ser null
`balance_notify_extra_emails`	`array` · `items: NotifyEmailEntry` · NotifyEmailEntry	não
`total_recharged`	`number`	não
`rpm_limit`	`integer`	não
`api_keys`	`array` · `items: APIKey` · APIKey	não

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`id`	`integer`	não
`title`	`string`	não
`content`	`string`	não
`notify_mode`	`string`	não
`starts_at`	`string`	não	; pode ser null
`ends_at`	`string`	não	; pode ser null
`read_at`	`string`	não	; pode ser null
`created_at`	`string`	não
`updated_at`	`string`	não

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`total_api_keys`	`integer`	não
`active_api_keys`	`integer`	não
`total_requests`	`integer`	não
`total_input_tokens`	`integer`	não
`total_output_tokens`	`integer`	não
`total_cache_creation_tokens`	`integer`	não
`total_cache_read_tokens`	`integer`	não
`total_tokens`	`integer`	não
`total_cost`	`number`	não	; Custo total ao preço normal
`total_actual_cost`	`number`	não	; Débito efetivo total
`today_requests`	`integer`	não
`today_input_tokens`	`integer`	não
`today_output_tokens`	`integer`	não
`today_cache_creation_tokens`	`integer`	não
`today_cache_read_tokens`	`integer`	não
`today_tokens`	`integer`	não
`today_cost`	`number`	não	; Custo de hoje ao preço normal
`today_actual_cost`	`number`	não	; Débito efetivo de hoje
`average_duration_ms`	`number`	não
`rpm`	`integer`	não	; Número médio de pedidos por minuto nos últimos 5 minutos
`tpm`	`integer`	não	; Número médio de tokens por minuto nos últimos 5 minutos

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`id`	`integer`	não
`email`	`string`	não
`username`	`string`	não
`role`	`string`	não
`balance`	`number`	não
`frozen_balance`	`number`	não
`concurrency`	`integer`	não
`status`	`string`	não
`last_active_at`	`string`	não	; pode ser null
`created_at`	`string`	não
`updated_at`	`string`	não
`deleted_at`	`string`	não	; pode ser null
`balance_notify_enabled`	`boolean`	não
`balance_notify_threshold_type`	`string`	não
`balance_notify_threshold`	`number`	não	; pode ser null
`balance_notify_extra_emails`	`array` · `items: NotifyEmailEntry` · NotifyEmailEntry	não
`total_recharged`	`number`	não
`rpm_limit`	`integer`	não
`api_keys`	`array` · `items: APIKey` · APIKey	não
`avatar_url`	`string`	não
`email_bound`	`boolean`	não

Campos do 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

O campo	Tipo	Obrigatório	Validação / descrição
`code`	`string`	sim	required

Campos do objeto

{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidateInvitationCodeResponse

O campo	Tipo	Obrigatório	Validação / descrição
`valid`	`boolean`	não
`error_code`	`string`	não

Campos do objeto

{
  "valid": "PLACEHOLDER_VALID (boolean)",
  "error_code": "PLACEHOLDER_ERROR_CODE (string)"
}

ValidatePromoCodeRequest

O campo	Tipo	Obrigatório	Validação / descrição
`code`	`string`	sim	required

Campos do objeto

{
  "code": "PLACEHOLDER_CODE (string)"
}

ValidatePromoCodeResponse

O campo	Tipo	Obrigatório
`valid`	`boolean`	não
`bonus_amount`	`number`	não
`error_code`	`string`	não
`message`	`string`	não

Campos do 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"
    }
  }
}

Ainda tem dúvidas? Envie o Request ID e uma descrição — ajudamos a esclarecer.Contactar o suporte