مخططات البيانات

حقول كائنات API لوحة الحساب وأنواعها.

الدليل الكامل

حقول كائنات API لوحة الحساب وأنواعها. تعني omitempty أن الحقل قد لا يظهر في الرد؛ ولا تعني السماح بإرسال null. تشير سلاسل PLACEHOLDER إلى النوع، لا إلى رد حقيقي.

APIKey

الحقل	النوع	مطلوب	التحقق / الوصف
`id`	`integer`	لا
`user_id`	`integer`	لا
`key`	`string`	لا
`name`	`string`	لا
`status`	`string`	لا
`ip_whitelist`	`array` · `items: string`	لا
`ip_blacklist`	`array` · `items: string`	لا
`last_used_at`	`string`	لا	؛ يمكن أن يكون null
`last_used_ip`	`string`	لا	؛ يمكن أن يكون null
`quota`	`number`	لا	؛ حد إنفاق المفتاح بالدولار USD؛ 0 يعني دون حد
`quota_used`	`number`	لا	؛ المبلغ المستخدم من حد المفتاح، بالدولار USD
`expires_at`	`string`	لا	؛ مدة الصلاحية؛ null تعني دون انتهاء؛ يمكن أن يكون null
`created_at`	`string`	لا
`updated_at`	`string`	لا
`current_concurrency`	`integer`	لا
`rate_limit_5h`	`number`	لا
`rate_limit_1d`	`number`	لا
`rate_limit_7d`	`number`	لا
`usage_5h`	`number`	لا
`usage_1d`	`number`	لا
`usage_7d`	`number`	لا
`window_5h_start`	`string`	لا	؛ يمكن أن يكون null
`window_1d_start`	`string`	لا	؛ يمكن أن يكون null
`window_7d_start`	`string`	لا	؛ يمكن أن يكون null
`reset_5h_at`	`string`	لا	؛ يمكن أن يكون null
`reset_1d_at`	`string`	لا	؛ يمكن أن يكون null
`reset_7d_at`	`string`	لا	؛ يمكن أن يكون null
`user`	object · 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

الحقل	النوع	مطلوب	التحقق / الوصف
`date`	`string`	لا
`requests`	`integer`	لا
`input_tokens`	`integer`	لا
`output_tokens`	`integer`	لا
`cache_read_tokens`	`integer`	لا
`cache_write_tokens`	`integer`	لا
`total_tokens`	`integer`	لا
`cost`	`number`	لا	؛ التكلفة بالسعر القياسي
`actual_cost`	`number`	لا	؛ الخصم الفعلي

حقول الكائن

{
  "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_token`	`string`	لا
`refresh_token`	`string`	لا	؛ توكن تجديد الجلسة
`expires_in`	`integer`	لا	؛ مدة صلاحية توكن الوصول بالثواني
`token_type`	`string`	لا
`user`	object · 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_ids`	`array` · `items: integer (int64)`	نعم	required

حقول الكائن

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

BatchAPIKeyUsageStats

الحقل	النوع	مطلوب
`api_key_id`	`integer`	لا
`today_actual_cost`	`number`	لا
`total_actual_cost`	`number`	لا

حقول الكائن

{
  "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_password`	`string`	نعم	required
`new_password`	`string`	نعم	required,min=6

حقول الكائن

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

CreateAPIKeyRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`name`	`string`	نعم	required
`custom_key`	`string`	لا	؛ قيمة مخصصة اختيارية للمفتاح؛ يمكن أن تكون null
`ip_whitelist`	`array` · `items: string`	لا	؛ قائمة عناوين IP المسموح بها
`ip_blacklist`	`array` · `items: string`	لا	؛ قائمة عناوين IP المحظورة
`quota`	`number`	لا	؛ حد إنفاق المفتاح بالدولار USD؛ يمكن أن يكون null
`expires_in_days`	`integer`	لا	؛ مدة الصلاحية بالأيام؛ يمكن أن تكون null
`rate_limit_5h`	`number`	لا	؛ يمكن أن يكون null
`rate_limit_1d`	`number`	لا	؛ يمكن أن يكون null
`rate_limit_7d`	`number`	لا	؛ يمكن أن يكون 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

الحقل	النوع	مطلوب	التحقق / الوصف
`email`	`string`	نعم	required,email
`turnstile_token`	`string`	لا

حقول الكائن

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

ForgotPasswordResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`message`	`string`	لا

حقول الكائن

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

Login2FARequest

الحقل	النوع	مطلوب	التحقق / الوصف
`temp_token`	`string`	نعم	required
`totp_code`	`string`	نعم	required,len=6

حقول الكائن

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

LoginRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`email`	`string`	نعم	required,email
`password`	`string`	نعم	required
`turnstile_token`	`string`	لا

حقول الكائن

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

LogoutRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`refresh_token`	`string`	لا	؛ اختياري: إبطال توكن التجديد المحدد

حقول الكائن

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

LogoutResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`message`	`string`	لا

حقول الكائن

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

PasskeyBeginLoginRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`turnstile_token`	`string`	لا

حقول الكائن

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

PasskeyCredentialSummary

الحقل	النوع	مطلوب	التحقق / الوصف
`id`	`integer`	لا
`name`	`string`	لا
`created_at`	`string`	لا
`last_used_at`	`string`	لا	؛ يمكن أن يكون null
`backup`	`boolean`	لا

حقول الكائن

{
  "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_token`	`string`	نعم	required
`name`	`string`	لا
`credential`	`object` · `WebAuthn PublicKeyCredential JSON`	نعم	required

حقول الكائن

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

PasskeyOptionsResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`session_token`	`string`	لا
`options`	`any`	لا

حقول الكائن

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

RedeemCode

الحقل	النوع	مطلوب	التحقق / الوصف
`id`	`integer`	لا
`code`	`string`	لا
`type`	`string`	لا
`value`	`number`	لا
`status`	`string`	لا
`used_by`	`integer`	لا	؛ يمكن أن يكون null
`used_at`	`string`	لا	؛ يمكن أن يكون null
`created_at`	`string`	لا
`expires_at`	`string`	لا	؛ يمكن أن يكون null
`validity_days`	`integer`	لا
`notes`	`string`	لا	؛ يمكن أن يكون null
`user`	object · 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

الحقل	النوع	مطلوب	التحقق / الوصف
`code`	`string`	نعم	required

حقول الكائن

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

RefreshTokenRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`refresh_token`	`string`	نعم	required

حقول الكائن

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

RefreshTokenResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`access_token`	`string`	لا
`refresh_token`	`string`	لا
`expires_in`	`integer`	لا	؛ مدة صلاحية توكن الوصول بالثواني
`token_type`	`string`	لا

حقول الكائن

{
  "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

الحقل	النوع	مطلوب	التحقق / الوصف
`email`	`string`	نعم	required,email
`password`	`string`	نعم	required,min=6
`verify_code`	`string`	لا
`turnstile_token`	`string`	لا
`promo_code`	`string`	لا	؛ الرمز الترويجي للتسجيل
`invitation_code`	`string`	لا	؛ رمز الدعوة

حقول الكائن

{
  "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

الحقل	النوع	مطلوب	التحقق / الوصف
`email`	`string`	نعم	required,email
`token`	`string`	نعم	required
`new_password`	`string`	نعم	required,min=6

حقول الكائن

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

ResetPasswordResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`message`	`string`	لا

حقول الكائن

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

RevokeAllSessionsResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`message`	`string`	لا

حقول الكائن

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

SendVerifyCodeRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`email`	`string`	نعم	required,email
`turnstile_token`	`string`	لا

حقول الكائن

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

SendVerifyCodeResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`message`	`string`	لا
`countdown`	`integer`	لا	؛ مدة الانتظار بالثواني

حقول الكائن

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

TotpLoginResponse

الحقل	النوع	مطلوب
`requires_2fa`	`boolean`	لا
`temp_token`	`string`	لا
`user_email_masked`	`string`	لا

حقول الكائن

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

TotpStatusResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`enabled`	`boolean`	لا
`enabled_at`	`integer`	لا	؛ Unix timestamp؛ يمكن أن يكون null
`feature_enabled`	`boolean`	لا

حقول الكائن

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

UpdateAPIKeyRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`name`	`string`	لا
`status`	`string`	لا	omitempty,oneof=active inactive
`ip_whitelist`	`array` · `items: string`	لا	؛ عناوين IP المسموح بها: لا تغيّر null القائمة، وتُفرغها المصفوفة الفارغة؛ يمكن أن تكون null
`ip_blacklist`	`array` · `items: string`	لا	؛ عناوين IP المحظورة: لا تغيّر null القائمة، وتُفرغها المصفوفة الفارغة؛ يمكن أن تكون null
`quota`	`number`	لا	؛ حد إنفاق المفتاح بالدولار USD؛ 0 يعني دون حد؛ يمكن أن يكون null
`expires_at`	`string`	لا	؛ وقت انتهاء الصلاحية بصيغة ISO 8601؛ يمكن أن يكون null
`reset_quota`	`boolean`	لا	؛ إعادة تعيين الجزء المستخدم من حد الإنفاق؛ يمكن أن يكون null
`rate_limit_5h`	`number`	لا	؛ يمكن أن يكون null
`rate_limit_1d`	`number`	لا	؛ يمكن أن يكون null
`rate_limit_7d`	`number`	لا	؛ يمكن أن يكون null
`reset_rate_limit_usage`	`boolean`	لا	؛ إعادة تعيين الإنفاق المحتسب ضمن حدود النوافذ الزمنية؛ يمكن أن يكون 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

الحقل	النوع	مطلوب	التحقق / الوصف
`username`	`string`	لا	؛ يمكن أن يكون null
`avatar_url`	`string`	لا	؛ يمكن أن يكون null
`balance_notify_enabled`	`boolean`	لا	؛ يمكن أن يكون null
`balance_notify_threshold`	`number`	لا	؛ يمكن أن يكون 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

الحقل	النوع	مطلوب	التحقق / الوصف
`id`	`integer`	لا
`user_id`	`integer`	لا
`api_key_id`	`integer`	لا
`request_id`	`string`	لا
`model`	`string`	لا
`service_tier`	`string`	لا	؛ يمكن أن يكون null
`reasoning_effort`	`string`	لا	؛ يمكن أن يكون null
`input_tokens`	`integer`	لا
`output_tokens`	`integer`	لا
`cache_creation_tokens`	`integer`	لا
`cache_read_tokens`	`integer`	لا
`cache_creation_5m_tokens`	`integer`	لا
`cache_creation_1h_tokens`	`integer`	لا
`input_cost`	`number`	لا
`output_cost`	`number`	لا
`cache_creation_cost`	`number`	لا
`cache_read_cost`	`number`	لا
`total_cost`	`number`	لا
`actual_cost`	`number`	لا
`long_context_billing_applied`	`boolean`	لا
`request_type`	`string`	لا
`stream`	`boolean`	لا
`duration_ms`	`integer`	لا	؛ يمكن أن يكون null
`first_token_ms`	`integer`	لا	؛ يمكن أن يكون null
`image_count`	`integer`	لا
`image_size`	`string`	لا	؛ يمكن أن يكون null
`image_input_size`	`string`	لا	؛ يمكن أن يكون null
`image_output_size`	`string`	لا	؛ يمكن أن يكون null
`image_input_tokens`	`integer`	لا
`image_input_cost`	`number`	لا
`image_output_tokens`	`integer`	لا
`image_output_cost`	`number`	لا
`image_size_breakdown`	`object` · `additionalProperties: integer`	لا
`media_type`	`string`	لا	؛ يمكن أن يكون null
`ip_address`	`string`	لا	؛ يمكن أن يكون null
`session_id`	`string`	لا	؛ يمكن أن يكون null
`created_at`	`string`	لا
`user`	object · User	لا	؛ يمكن أن يكون null
`api_key`	object · 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_requests`	`integer`	لا
`total_input_tokens`	`integer`	لا
`total_output_tokens`	`integer`	لا
`total_cache_tokens`	`integer`	لا
`total_cache_creation_tokens`	`integer`	لا
`total_cache_read_tokens`	`integer`	لا
`total_tokens`	`integer`	لا
`total_cost`	`number`	لا
`total_actual_cost`	`number`	لا
`average_duration_ms`	`number`	لا
`endpoints`	`array` · `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

الحقل	النوع	مطلوب	التحقق / الوصف
`id`	`integer`	لا
`email`	`string`	لا
`username`	`string`	لا
`role`	`string`	لا
`balance`	`number`	لا
`frozen_balance`	`number`	لا
`concurrency`	`integer`	لا
`status`	`string`	لا
`last_active_at`	`string`	لا	؛ يمكن أن يكون null
`created_at`	`string`	لا
`updated_at`	`string`	لا
`deleted_at`	`string`	لا	؛ يمكن أن يكون null
`balance_notify_enabled`	`boolean`	لا
`balance_notify_threshold_type`	`string`	لا
`balance_notify_threshold`	`number`	لا	؛ يمكن أن يكون null
`balance_notify_extra_emails`	`array` · `items: NotifyEmailEntry` · NotifyEmailEntry	لا
`total_recharged`	`number`	لا
`rpm_limit`	`integer`	لا
`api_keys`	`array` · `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

الحقل	النوع	مطلوب	التحقق / الوصف
`id`	`integer`	لا
`title`	`string`	لا
`content`	`string`	لا
`notify_mode`	`string`	لا
`starts_at`	`string`	لا	؛ يمكن أن يكون null
`ends_at`	`string`	لا	؛ يمكن أن يكون null
`read_at`	`string`	لا	؛ يمكن أن يكون null
`created_at`	`string`	لا
`updated_at`	`string`	لا

حقول الكائن

{
  "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_keys`	`integer`	لا
`active_api_keys`	`integer`	لا
`total_requests`	`integer`	لا
`total_input_tokens`	`integer`	لا
`total_output_tokens`	`integer`	لا
`total_cache_creation_tokens`	`integer`	لا
`total_cache_read_tokens`	`integer`	لا
`total_tokens`	`integer`	لا
`total_cost`	`number`	لا	؛ إجمالي التكلفة بالسعر القياسي
`total_actual_cost`	`number`	لا	؛ إجمالي الخصم الفعلي
`today_requests`	`integer`	لا
`today_input_tokens`	`integer`	لا
`today_output_tokens`	`integer`	لا
`today_cache_creation_tokens`	`integer`	لا
`today_cache_read_tokens`	`integer`	لا
`today_tokens`	`integer`	لا
`today_cost`	`number`	لا	؛ تكلفة اليوم بالسعر القياسي
`today_actual_cost`	`number`	لا	؛ الخصم الفعلي لليوم
`average_duration_ms`	`number`	لا
`rpm`	`integer`	لا	؛ متوسط عدد الطلبات في الدقيقة خلال آخر 5 دقائق
`tpm`	`integer`	لا	؛ متوسط عدد التوكنات في الدقيقة خلال آخر 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

الحقل	النوع	مطلوب	التحقق / الوصف
`id`	`integer`	لا
`email`	`string`	لا
`username`	`string`	لا
`role`	`string`	لا
`balance`	`number`	لا
`frozen_balance`	`number`	لا
`concurrency`	`integer`	لا
`status`	`string`	لا
`last_active_at`	`string`	لا	؛ يمكن أن يكون null
`created_at`	`string`	لا
`updated_at`	`string`	لا
`deleted_at`	`string`	لا	؛ يمكن أن يكون null
`balance_notify_enabled`	`boolean`	لا
`balance_notify_threshold_type`	`string`	لا
`balance_notify_threshold`	`number`	لا	؛ يمكن أن يكون null
`balance_notify_extra_emails`	`array` · `items: NotifyEmailEntry` · NotifyEmailEntry	لا
`total_recharged`	`number`	لا
`rpm_limit`	`integer`	لا
`api_keys`	`array` · `items: APIKey` · APIKey	لا
`avatar_url`	`string`	لا
`email_bound`	`boolean`	لا

حقول الكائن

{
  "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

الحقل	النوع	مطلوب	التحقق / الوصف
`code`	`string`	نعم	required

حقول الكائن

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

ValidateInvitationCodeResponse

الحقل	النوع	مطلوب	التحقق / الوصف
`valid`	`boolean`	لا
`error_code`	`string`	لا

حقول الكائن

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

ValidatePromoCodeRequest

الحقل	النوع	مطلوب	التحقق / الوصف
`code`	`string`	نعم	required

حقول الكائن

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

ValidatePromoCodeResponse

الحقل	النوع	مطلوب
`valid`	`boolean`	لا
`bonus_amount`	`number`	لا
`error_code`	`string`	لا
`message`	`string`	لا

حقول الكائن

{
  "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 ووصفاً للمشكلة وسنساعدك على فهمها.مراسلة الدعم