> ## 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. # Utilisation et quotas > Points libre-service, budget et instantané de la limite de débit pour une clé API # Utilisation et quotas Renvoie un instantané en libre-service du quota et de l'utilisation de la clé API appelante : le compartiment de points de l'utilisateur facturé, le budget d'utilisation par modèle lorsqu'il est activé, ainsi que les propres limites de requêtes et limites de débit de la clé. Il s'agit des mêmes données que vous liriez autrement dans le panneau d'administration, exposées au détenteur de la clé. ## Point de terminaison ``` GET /usage ``` ## Authentification ```bash theme={null} Authorization: Bearer sk-your-api-key-here ``` ## Exemple de demande ```bash theme={null} curl -X GET "https://{customer.name}.hiperai.ai/api/external/usage" \ -H "Authorization: Bearer sk-your-api-key-here" ``` ## Réponse ```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 } } ``` ### Champs | Champ | Descriptif | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `points.remaining` | Points restants dans le bucket de l'utilisateur facturé. | | `points.monthly_limit` | L'allocation mensuelle de points de l'utilisateur. | | `points.next_renewal` | Horodatage ISO du prochain renouvellement des points. | | `usage_by_model` | Lorsque l'utilisateur facturé est en mode de facturation Utilisation par modèle : `dollar_limit`, `current_spend`, `remaining_budget`. Sinon `{ "enabled": false }`. | | `api_key.billing_mode` | `user-completions` ou `usage-by-model` — voir [Modes de facturation](/fr/en/api/billing-modes). | | `api_key.daily` / `api_key.monthly` | Les compteurs de requêtes de la clé (`used`, `limit`, `remaining`). | | `api_key.rate_limit` | Plafonds de demande par minute et par heure. | | `api_key.expires_at` | Horodatage d'expiration ISO, ou `null` si la clé n'expire jamais. | ## Remarques * Les valeurs reflètent l'utilisateur **facturé**, qui peut différer du propriétaire de la clé lorsque les demandes utilisent `user_id` pour le compte de la facturation. * Pour prévisualiser si une requête *spécifique* dépassera son quota (sans dépenses), utilisez [Policy Check](/fr/en/api/policy-check) et lisez `checks.quota`. ## Connexes * [Modes de facturation](/fr/en/api/billing-modes) * [Présentation de l'authentification](/fr/en/api/auth/overview) * [Policy Check](/fr/en/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` ````