Gatewayz Universal Inference API
  1. health
Gatewayz Universal Inference API
  • models
    • Get All Models
      GET
    • Get Specific Model Api
      GET
    • Get Specific Model Api Legacy
      GET
    • Get Developer Models Api
      GET
    • Search Models
      GET
  • authentication
    • Root
      GET
    • Privy Auth
      POST
    • Register User
      POST
    • Request Password Reset
      POST
    • Reset Password
      POST
    • Get User Balance
      GET
    • User Monitor
      GET
    • User Get Rate Limits
      GET
    • Get User Profile Endpoint
      GET
    • Update User Profile Endpoint
      PUT
    • Delete User Account Endpoint
      DELETE
    • Get Credit Transactions Endpoint
      GET
    • List User Api Keys
      GET
    • Create User Api Key
      POST
    • Update User Api Key Endpoint
      PUT
    • Delete User Api Key
      DELETE
    • Get User Api Key Usage
      GET
    • Create Api Key
      POST
    • Get User Audit Logs
      GET
    • Get User Plan Endpoint
      GET
    • Get User Plan Usage
      GET
    • Get User Plan Entitlements
      GET
    • Get User Environment Usage
      GET
    • Get User Rate Limits Advanced
      GET
    • Update User Rate Limits Advanced
      PUT
    • Bulk Update User Rate Limits
      POST
    • Get Api Key Rate Limit Usage
      GET
  • admin
    • Admin Add Credits
    • Admin Get All Balances
    • Admin Monitor
    • Admin Set Rate Limit
    • Admin Refresh Providers
    • Admin Cache Status
    • Admin Huggingface Cache Status
    • Admin Refresh Huggingface Cache
    • Admin Test Huggingface
    • Admin Debug Models
    • Admin Clear Rate Limit Cache
    • Get Trial Analytics Admin
    • Get All Users Info
    • Get All Credit Transactions Admin
    • Get User Info By Id
    • Get Notification Stats
    • Process Notifications
    • Assign Plan To User
    • Get System Rate Limits
    • Get Rate Limit Alerts Endpoint
    • Create Coupon Endpoint
    • List Coupons Endpoint
    • Get Coupon Endpoint
    • Update Coupon Endpoint
    • Deactivate Coupon Endpoint
    • Get Coupon Analytics Endpoint
    • Get Coupon Stats Endpoint
    • Update Role
    • Get User Role Info
    • Get Audit Log
    • List Users By Role
    • Get Role Permissions Endpoint
  • plans
    • Get Plans
    • Get Plan
  • notifications
    • Get Notification Preferences
    • Update Notification Preferences
    • Test Notification
    • Send Usage Report
  • trial
    • Get Trial Status
  • subscription
    • Get Subscription Plans
  • providers
    • Get Providers
  • debug
    • Test Provider Matching
    • Test Refresh Providers
    • Test Openrouter Providers
  • Stripe Payments
    • Stripe Webhook
    • Create Checkout Session
    • Get Checkout Session
    • Create Payment Intent
    • Get Payment Intent
    • Get Credit Packages
    • Create Refund
    • Get Payment History
    • Get Payment Details
    • Create Subscription Checkout
  • chat
    • Chat Completions
    • Unified Responses
    • Anthropic Messages
  • chat-history
    • Create Session
    • Get Sessions
    • Get Session
    • Update Session
    • Delete Session
    • Get Stats
    • Search Sessions
    • Save Message
  • ranking
    • Get Ranking Models
    • Get Ranking Apps
  • Activity
    • Get Activity Stats
    • Get Activity Log
  • coupons
    • Redeem Coupon Endpoint
    • Get Available Coupons
    • Get Redemption History
  • Analytics
    • Get Transaction Analytics
    • Get Transaction Summary
  • statistics
    • Get Provider Statistics
    • Get Gateway Statistics
    • Get All Gateways Summary Endpoint
    • Get Provider Top Models Endpoint
    • Get Trending Models Api
  • comparison
    • Batch Compare Models Api
    • Compare Model Gateways Api
  • referral
    • Get My Referral Stats
    • Validate Referral
    • Generate My Referral Code
    • Get My Referral Code
  • cache
    • Get Cache Status
    • Refresh Gateway Cache
    • Clear All Caches
    • Get Modelz Cache Status
    • Refresh Modelz Cache Endpoint
    • Clear Modelz Cache Endpoint
  • health
    • Get System Health
      GET
    • Get Providers Health
      GET
    • Get Models Health
      GET
    • Get Model Health
      GET
    • Get Provider Health
      GET
    • Get Health Summary
      GET
    • Perform Health Check
      POST
    • Perform Immediate Health Check
      POST
    • Get Uptime Metrics
      GET
    • Get Health Dashboard
      GET
    • Get Health Status
      GET
    • Get Monitoring Status
      GET
    • Start Health Monitoring
      POST
    • Stop Health Monitoring
      POST
    • Check Google Vertex Health
      GET
    • Trigger Gateway Fix
      POST
    • Check All Gateways
      GET
    • Gateway Health Dashboard
      GET
    • Gateway Health Dashboard Data
      GET
    • Check Single Gateway
      GET
  • images
    • Generate Images
  • analytics
    • Log Event
    • Log Batch Events
  • availability
    • Get Available Models
    • Get Model Availability
    • Check Model Availability
    • Get Fallback Models
    • Get Best Available Model
    • Get Availability Summary
    • Set Maintenance Mode
    • Clear Maintenance Mode
    • Start Availability Monitoring
    • Stop Availability Monitoring
    • Get Availability Status
  • Health Check
    GET
  • Ping
    GET
  • Ping Stats
    GET
  • Get Modelz Models
    GET
  • Get Modelz Model Ids Endpoint
    GET
  • Check Model On Modelz
    GET
  • Get Optimization Health
    GET
  • Get Connection Pool Stats
    GET
  • Get Cache Health
    GET
  • Get Prioritization Stats
    GET
  • Clear Cache
    POST
  • Schemas
    • AddCreditsRequest
    • AssignPlanRequest
    • AnthropicMessage
    • AnalyticsEvent
    • AuthMethod
    • CreateApiKeyRequest
    • ChatMessage
    • AvailableCouponResponse
    • DeleteAccountRequest
    • ChatSession
    • DeleteAccountResponse
    • ChatSessionResponse
    • AvailabilityStatus
    • DeleteApiKeyRequest
    • ChatSessionStatsResponse
    • HTTPValidationError
    • NotificationPreferences
    • ChatSessionsListResponse
    • NotificationStats
    • PlanEntitlementsResponse
    • NotificationType
    • CreateChatSessionRequest
    • CouponAnalyticsResponse
    • PlanResponse
    • CreateCheckoutSessionRequest
    • CouponResponse
    • ContentBlock
    • PlanUsageResponse
    • CreatePaymentIntentRequest
    • CouponScope
    • CreateRefundRequest
    • CouponStatsResponse
    • CircuitBreakerState
    • PrivyAuthRequest
    • CouponType
    • PrivyAuthResponse
    • PrivyLinkedAccount
    • UpdateApiKeyRequest
    • PrivyUserData
    • UserPlanResponse
    • Message
    • CreateCouponRequest
    • UserProfileResponse
    • UpdateNotificationPreferencesRequest
    • UserProfileUpdate
    • ValidationError
    • InputMessage
    • ListCouponsResponse
    • CreateSubscriptionCheckoutRequest
    • ImageData
    • ProxyRequest
    • ImageGenerationRequest
    • RateLimitConfig
    • MessagesRequest
    • ImageGenerationResponse
    • SearchChatSessionsRequest
    • HealthCheckRequest
    • SetRateLimitRequest
    • HealthDashboardResponse
    • StripeCurrency
    • HealthStatus
    • StripePaymentMethodType
    • HealthSummaryResponse
    • SubscriptionStatus
    • UpdateChatSessionRequest
    • RedeemCouponRequest
    • RedemptionHistoryItem
    • UserRegistrationRequest
    • RedemptionHistoryResponse
    • ModelAvailability
    • UserRegistrationResponse
    • RedemptionResponse
    • ModelHealthResponse
    • ResponseFormat
    • ModelStatusResponse
    • ResponseFormatType
    • ResponseRequest
    • RoleAuditLogResponse
    • ReferralStatsResponse
    • RoleResponse
    • SaveChatMessageRequest
    • ProviderHealthResponse
    • ProviderStatus
    • UpdateCouponRequest
    • ProviderStatusResponse
    • UpdateRoleRequest
    • ValidateReferralRequest
    • ValidateReferralResponse
    • SystemHealthResponse
    • UptimeMetricsResponse
  1. health

Get Health Summary

GET
/health/summary
Get comprehensive health summary
Returns a complete health overview including:
System health metrics
All provider health data
All model health data
Monitoring status

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or

Responses

🟢200OK
application/json
Successful Response
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/health/summary' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "system": {
        "overall_status": "healthy",
        "total_providers": 0,
        "healthy_providers": 0,
        "degraded_providers": 0,
        "unhealthy_providers": 0,
        "total_models": 0,
        "healthy_models": 0,
        "degraded_models": 0,
        "unhealthy_models": 0,
        "system_uptime": 0,
        "last_updated": "2019-08-24T14:15:22Z"
    },
    "providers": [
        {
            "provider": "string",
            "gateway": "string",
            "status": "online",
            "total_models": 0,
            "healthy_models": 0,
            "degraded_models": 0,
            "unhealthy_models": 0,
            "avg_response_time_ms": 0,
            "overall_uptime": 0,
            "last_checked": "2019-08-24T14:15:22Z",
            "error_message": "string"
        }
    ],
    "models": [
        {
            "model_id": "string",
            "provider": "string",
            "gateway": "string",
            "status": "healthy",
            "response_time_ms": 0,
            "success_rate": 0,
            "last_checked": "2019-08-24T14:15:22Z",
            "last_success": "2019-08-24T14:15:22Z",
            "last_failure": "2019-08-24T14:15:22Z",
            "error_count": 0,
            "total_requests": 0,
            "avg_response_time_ms": 0,
            "uptime_percentage": 0,
            "error_message": "string"
        }
    ],
    "monitoring_active": false,
    "last_check": "2019-08-24T14:15:22Z"
}
Modified at 2025-11-07 03:16:46
Previous
Get Provider Health
Next
Perform Health Check
Built with