> ## 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.

# Available Knowledge Bases

> Retrieve available knowledge bases (indexes) that your API key can access.
Includes personal indexes, shared indexes, and the Zero-Knowledge option.


# Get Available Knowledge Bases

Retrieve available knowledge bases (indexes) that your API key can access.

## Endpoint

```
GET /indexes
```

## Description

Retrieve available knowledge bases (indexes) that your API key can access. Includes personal indexes, shared indexes, and the Zero-Knowledge option.

## Authentication

Required: API Key

```bash theme={null}
Authorization: Bearer sk-your-api-key-here
```

## Request

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/indexes" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

## Response

### Success Response (200)

```json theme={null}
{
  "success": true,
  "indexes": [
    {
      "id": "Zero-Knowledge",
      "name": "Zero-Knowledge",
      "type": "system",
      "description": "Direct AI responses without knowledge base retrieval"
    },
    {
      "id": "my-knowledge-base",
      "name": "my-knowledge-base",
      "type": "personal",
      "namespace": "user-namespace"
    }
  ],
  "restrictions": {
    "allowed_indexes": "all user indexes"
  }
}
```

### Response Fields

| Field          | Type    | Description                         | Example     |
| -------------- | ------- | ----------------------------------- | ----------- |
| `success`      | boolean | Always true for successful requests | `true`      |
| `indexes`      | array   | List of available knowledge bases   | See example |
| `restrictions` | object  | Index access restrictions           | See example |

### Index Object

| Field         | Type   | Description                  | Example                    |
| ------------- | ------ | ---------------------------- | -------------------------- |
| `id`          | string | Unique index identifier      | `"my-knowledge-base"`      |
| `name`        | string | Index display name           | `"my-knowledge-base"`      |
| `type`        | string | Index type                   | `"personal"`               |
| `namespace`   | string | Index namespace (optional)   | `"user-namespace"`         |
| `description` | string | Index description (optional) | `"Direct AI responses..."` |

### Index Types

| Type       | Description                                    |
| ---------- | ---------------------------------------------- |
| `system`   | System-provided indexes (e.g., Zero-Knowledge) |
| `personal` | User's personal knowledge bases                |
| `general`  | Shared knowledge bases                         |

### Restrictions Object

| Field             | Type   | Description                    | Example              |
| ----------------- | ------ | ------------------------------ | -------------------- |
| `allowed_indexes` | string | Description of allowed indexes | `"all user indexes"` |

## Error Responses

### 401 Unauthorized

```json theme={null}
{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}
```

## Example Usage

### JavaScript/Node.js

```javascript theme={null}
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/indexes', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

const data = await response.json();
console.log('Available Indexes:', data.indexes);
```

### Python

```python theme={null}
import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

response = requests.get('https://{customer.name}.hiperai.ai/api/external/indexes', headers=headers)
data = response.json()

print('Available Indexes:', data['indexes'])
```

### cURL

```bash theme={null}
curl -X GET "https://{customer.name}.hiperai.ai/api/external/indexes" \
  -H "Authorization: Bearer sk-your-api-key-here"
```

## Special Indexes

### Zero-Knowledge

The `Zero-Knowledge` index is a special system index that provides direct AI responses without knowledge base retrieval. Use this when you want:

* Pure AI responses without RAG
* Testing AI model capabilities
* General conversation without specific context

## Notes

* The Zero-Knowledge index is always available
* Personal indexes are created by the user
* Access to indexes depends on your permissions
* Use the index ID in chat completion requests


## OpenAPI

````yaml GET /indexes
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:
  /indexes:
    get:
      tags:
        - Discovery
      summary: Get Available Knowledge Bases
      description: >
        Retrieve available knowledge bases (indexes) that your API key can
        access.

        Includes personal indexes, shared indexes, and the Zero-Knowledge
        option.
      responses:
        '200':
          description: List of available knowledge bases
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  indexes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: my-knowledge-base
                        name:
                          type: string
                          example: my-knowledge-base
                        type:
                          type: string
                          enum:
                            - system
                            - personal
                            - general
                          example: personal
                        namespace:
                          type: string
                          example: user-namespace
                        description:
                          type: string
                          example: Direct AI responses without knowledge base retrieval
                  restrictions:
                    type: object
                    properties:
                      allowed_indexes:
                        type: string
                        example: all user indexes
              example:
                success: true
                indexes:
                  - id: Zero-Knowledge
                    name: Zero-Knowledge
                    type: system
                    description: Direct AI responses without knowledge base retrieval
                  - id: my-knowledge-base
                    name: my-knowledge-base
                    type: personal
                    namespace: user-namespace
                restrictions:
                  allowed_indexes: all user indexes
        '401':
          description: Invalid API key
          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`

````