> ## Documentation Index > Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt > Use this file to discover all available pages before exploring further. # Usage & Quota > Self-service points, budget, and rate-limit snapshot for an API key # Usage & Quota Return a self-service snapshot of the calling API key's quota and usage: the billed user's points bucket, the Usage-by-Model budget when enabled, and the key's own request limits and rate limits. This is the same data you'd otherwise read from the admin panel, exposed to the key holder. ## Endpoint ``` GET /usage ``` ## Authentication ```bash theme={null} Authorization: Bearer sk-your-api-key-here ``` ## Request Example ```bash theme={null} curl -X GET "https://{customer.name}.hiperai.ai/api/external/usage" \ -H "Authorization: Bearer sk-your-api-key-here" ``` ## Response ```json theme={null} { "success": true, "points": { "remaining": 4188, "monthly_limit": 5000, "next_renewal": "2026-08-01T00:00:00.000Z" }, "usage_by_model": { "enabled": true, "dollar_limit": 250, "current_spend": 61.4, "remaining_budget": 188.6 }, "api_key": { "name": "Production integration", "billing_mode": "user-completions", "daily": { "used": 120, "limit": 1000, "remaining": 880 }, "monthly": { "used": 3400, "limit": 10000, "remaining": 6600 }, "rate_limit": { "requests_per_minute": 60, "requests_per_hour": 1000 }, "expires_at": null } } ``` ### Fields | Field | Description | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `points.remaining` | Points left in the billed user's bucket. | | `points.monthly_limit` | The user's monthly points allowance. | | `points.next_renewal` | ISO timestamp of the next points renewal. | | `usage_by_model` | When the billed user is on the Usage-by-Model billing mode: `dollar_limit`, `current_spend`, `remaining_budget`. Otherwise `{ "enabled": false }`. | | `api_key.billing_mode` | `user-completions` or `usage-by-model` — see [Billing Modes](/api/billing-modes). | | `api_key.daily` / `api_key.monthly` | The key's request counters (`used`, `limit`, `remaining`). | | `api_key.rate_limit` | Per-minute and per-hour request ceilings. | | `api_key.expires_at` | ISO expiry timestamp, or `null` if the key never expires. | ## Notes * Values reflect the **billed** user, which may differ from the key owner when requests use `user_id` on-behalf-of billing. * To preview whether a *specific* request would pass its quota (without spending), use [Policy Check](/api/policy-check) and read `checks.quota`. ## Related * [Billing Modes](/api/billing-modes) * [Authentication Overview](/api/auth/overview) * [Policy Check](/api/policy-check) ## OpenAPI ````yaml GET /usage openapi: 3.0.3 info: title: SecureAI External API description: > SecureAI External API provides AI chat completion and image generation capabilities with knowledge base retrieval, security policies, and comprehensive usage tracking. This API is designed for external developers and integrations using API key authentication. ## Key Features - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge bases for relevant context - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI models - **Model Redundancy & Failover**: Caller-defined failover chains (primary + fallbacks) with per-attempt timeouts - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1` — no code changes - **Image Generation**: Generate and edit images using Google Gemini 2.5 Flash Image - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI Realtime API with WebRTC - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield, and signed compliance receipts - **Usage Tracking**: Comprehensive usage monitoring, self-service quota, and rate limiting - **Knowledge Base Integration**: Access to personal and shared knowledge bases - **User Management**: Complete user, group, and role management capabilities - **Audit Logging**: Comprehensive activity and security audit logs ## Authentication All endpoints (except health check) require API key authentication using Bearer token: ``` Authorization: Bearer sk-your-api-key-here ``` ## Billing and Usage By default, API requests are billed to the user account that owns the API key. You can specify a different user to bill by including the `user_id` parameter in your request. This allows for: - Multi-tenant applications with per-user billing - Flexible completion limit management - Per-user "Usage by Model" settings ## Rate Limits - Default: 60 requests per minute, 1000 requests per hour - Daily limits: 100 requests (configurable) - Monthly limits: 10,000 requests (configurable) ## Base URL ``` https://secureai.hiperai.ai/api/external ``` version: 1.1.0 contact: name: SecureAI Support email: support@secureai.hiperai.ai license: name: Proprietary url: https://secureai.hiperai.ai/terms servers: - url: https://secureai.hiperai.ai/api/external description: Production server - url: http://localhost:3010/api/external description: Development server security: - ApiKeyAuth: [] tags: - name: System description: System health and status endpoints - name: Discovery description: Endpoints to discover available models, indexes, and policies - name: Chat description: AI chat completion endpoints - name: User Management description: Endpoints for managing user accounts and roles - name: Index Management description: Endpoints for managing knowledge base indexes - name: Group Management description: Endpoints for managing user groups - name: SMLTP Security description: Endpoints for managing SMLTP security policies and audit logs - name: Role Management description: Endpoints for managing user roles - name: Activity Logs description: Endpoints for retrieving activity logs externalDocs: description: SecureAI Documentation url: https://secureai.hiperai.ai/docs paths: /usage: get: tags: - System summary: Self-service quota and usage snapshot description: | Returns the billed user's points bucket, the Usage-by-Model budget (when enabled), and the calling key's daily/monthly counters and rate limits. operationId: getUsage responses: '200': description: Points, usage_by_model, and api_key limit snapshot '401': description: Invalid API key security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key authentication using Bearer token format. Example: `Authorization: Bearer sk-your-api-key-here` ````