> ## 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. # Licenses Availability > Retrieve current license pool limits, usage, and remaining (admin only) # Licenses Availability Retrieve license pool limits, current usage, and remaining licenses for each tier. ## Endpoint ``` GET /licenses/availability ``` ## Description Returns the license pool status for all license tiers, including limits, current usage, and remaining capacity. Admin-only endpoint. ## Authentication **Required**: API Key with admin privileges ``` Authorization: Bearer sk-your-api-key-here ``` ## Request ```bash theme={null} curl -X GET "https://{customer.name}.hiperai.ai/api/external/licenses/availability" \ -H "Authorization: Bearer sk-your-api-key-here" ``` ## Response ### Success Response (200) ```json theme={null} { "success": true, "limits": { "Essential": 1, "Growth": 0, "Ultra": 2, "Early Access": 12 }, "usage": { "Essential": 1, "Growth": 5, "Ultra": 1, "Early Access": 0 }, "remaining": { "Essential": 0, "Growth": Infinity, "Ultra": 1, "Early Access": 12 } } ``` ### Response Fields | Field | Type | Description | | ----------- | ------- | ----------------------------------------- | | `success` | boolean | Indicates if the operation was successful | | `limits` | object | License pool configured limits per tier | | `usage` | object | Current assigned/used licenses per tier | | `remaining` | object | Remaining licenses per tier | ## Error Responses ### 401 Unauthorized ```json theme={null} { "success": false, "error": "Invalid API key", "message": "The provided API key is invalid or has been revoked" } ``` ### 403 Forbidden ```json theme={null} { "success": false, "error": "Access denied", "message": "Admin access required" } ``` ## Notes * Admin-only endpoint * Remaining may be reported as `Infinity` when no pool limit is enforced for that tier * Values are organization-wide aggregates ## OpenAPI ````yaml GET /licenses/availability 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: /licenses/availability: get: tags: - User Management summary: Get License Availability description: > Retrieve license pool limits and current usage/remaining counts. Only accessible by administrators. responses: '200': description: License availability content: application/json: schema: type: object properties: success: type: boolean example: true limits: type: object additionalProperties: type: integer example: Essential: 1 Growth: 0 Ultra: 2 Early Access: 12 usage: type: object additionalProperties: type: integer example: Essential: 1 Growth: 5 Ultra: 1 Early Access: 0 remaining: type: object additionalProperties: oneOf: - type: integer - type: number example: Essential: 0 Growth: 1.7976931348623157e+308 Ultra: 1 Early Access: 12 '401': description: Invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Access denied - admin only content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKeyAuth: [] components: schemas: ErrorResponse: type: object properties: success: type: boolean example: false error: type: string example: Invalid API key message: type: string example: The provided API key is invalid or has been revoked request_id: type: string example: req-abc123 description: Request ID for tracking (if available) securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key authentication using Bearer token format. Example: `Authorization: Bearer sk-your-api-key-here` ````