Gatewayz Universal Inference API
    Gatewayz Universal Inference API
    • Getting Started
    • 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 Providers Health
      • Get Models Health
      • Get Model Health
      • Get Provider Health
      • Get Health Summary
      • Perform Health Check
      • Perform Immediate Health Check
      • Get Uptime Metrics
      • Get Health Dashboard
      • Get Health Status
      • Get Monitoring Status
      • Start Health Monitoring
      • Stop Health Monitoring
      • Check Google Vertex Health
      • Trigger Gateway Fix
      • Check All Gateways
      • Gateway Health Dashboard
      • Gateway Health Dashboard Data
      • Check Single Gateway
    • 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

    Getting Started

    Gatewayz Universal Inference API#

    Welcome to the Gatewayz docs.
    Gatewayz gives you one API that connects to more than ten thousand AI models across major providers and specialized fine tunes, with routing, health checks, and billing handled for you. :contentReference[oaicite:0]{index=0}
    If you are tired of juggling three providers before lunch, you are in the right place.

    What Gatewayz is#

    Gatewayz is a universal inference gateway for LLMs and other AI models:
    One OpenAI compatible API over https://api.gatewayz.ai
    Access to GPT, Claude, Llama, Qwen, DeepSeek, Gemini, and thousands of fine tuned models through a single integration :contentReference[oaicite:1]{index=1}
    Built in routing, load balancing, circuit breakers, and automatic fallbacks
    Centralized credit metering, usage tracking, and billing
    Enterprise features like rate limiting, audit logging, and role based access control :contentReference[oaicite:2]{index=2}
    Behind the scenes, Gatewayz continuously benchmarks models on latency, cost, reliability, context length, and more, then routes each request to the best model for your policy, while keeping your code compatible with OpenAI style clients. :contentReference[oaicite:3]{index=3}

    How these docs are organized#

    Use the left sidebar for the full auto generated API reference. At a high level:
    models
    List, search, and inspect models exposed through Gatewayz. :contentReference[oaicite:4]{index=4}
    chat
    OpenAI compatible chat completions and unified responses.
    authentication
    Sign in, manage users, view balances, manage API keys and rate limits, and inspect audit logs. :contentReference[oaicite:5]{index=5}
    chat-history
    Create sessions, store messages, and query conversation stats.
    ranking, comparison, statistics, availability
    Discover models, compare them, and inspect availability and performance.
    Stripe Payments, plans, subscription, coupons, referral
    Manage billing, subscriptions, coupons, and referral incentives.
    health, debug, admin, Analytics, Activity
    Deep operational visibility, health checks, dashboards, and admin tooling.
    If you just want to get a model responding to your prompt as fast as possible, start with the Quickstart below.

    Quickstart#

    1. Get an API key#

    1.
    Go to your Gatewayz dashboard at https://gatewayz.ai.
    2.
    Create an account and generate an API key.
    3.
    Store the key securely, do not commit it to Git.
    All API calls are authenticated with a Bearer token:
    Authorization: Bearer YOUR_API_KEY
    Modified at 2025-12-11 04:42:49
    Next
    Get All Models
    Built with