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

# Create Index

> Create a new knowledge base index

# Create Index

Create a new knowledge base index for storing and retrieving documents.

## Endpoint

```
POST /indexes
```

## Description

This endpoint allows administrators to create a new knowledge base index. The index can be assigned to specific users or groups. Only administrators can create indexes.

## Authentication

**Required**: API Key with admin privileges

```
Authorization: Bearer sk-your-api-key-here
```

## Request Body

| Parameter         | Type   | Required | Description                                              |
| ----------------- | ------ | -------- | -------------------------------------------------------- |
| `name`            | string | Yes      | Index name                                               |
| `assignedUser`    | string | No       | User ID to assign the index to (MongoDB ObjectId)        |
| `assignedGroup`   | string | No       | Group ID to assign the index to (MongoDB ObjectId)       |
| `sharedIndexName` | string | No       | Shared index name (defaults to name)                     |
| `namespace`       | string | No       | Namespace for the index (auto-generated if not provided) |
| `region`          | string | No       | Region hint for storage (optional)                       |
| `cloud`           | string | No       | Cloud provider hint (optional)                           |

## Example Request

```json theme={null}
{
  "name": "my-knowledge-base",
  "assignedUser": "60a7c8f5e8b4f5001f7a8c24",
  "sharedIndexName": "my-knowledge-base",
  "region": "us-east-1",
  "cloud": "aws"
}
```

## Success Response

**Status Code**: `201 Created`

```json theme={null}
{
  "success": true,
  "message": "Index created successfully",
  "index": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "my-knowledge-base",
    "sharedIndexName": "my-knowledge-base",
    "namespace": "user-60a7c8f5e8b4f5001f7a8c24-index-my-knowledge-base",
    "type": "personal",
    "assignedUser": {
      "id": "60a7c8f5e8b4f5001f7a8c24",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "assignedGroup": null,
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
```

### Response Fields

| Field                   | Type    | Description                                    |
| ----------------------- | ------- | ---------------------------------------------- |
| `success`               | boolean | Indicates if the operation was successful      |
| `message`               | string  | Success message                                |
| `index`                 | object  | Created index object                           |
| `index.id`              | string  | Unique index identifier                        |
| `index.name`            | string  | Index name                                     |
| `index.sharedIndexName` | string  | Shared index name                              |
| `index.namespace`       | string  | Index namespace                                |
| `index.type`            | string  | Index type (personal, general, group, unknown) |
| `index.assignedUser`    | object  | Assigned user information (if personal)        |
| `index.assignedGroup`   | object  | Assigned group information (if group)          |
| `index.createdAt`       | string  | Creation timestamp                             |

## Example Usage

### JavaScript

```javascript theme={null}
const createIndex = async (indexData) => {
  const response = await fetch('https://{customer.name}.hiperai.ai/api/external/indexes', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(indexData)
  });
  
  return await response.json();
};

// Example usage
const indexData = {
  name: "my-knowledge-base",
  assignedUser: "60a7c8f5e8b4f5001f7a8c24",
  region: "us-east-1",
  cloud: "aws"
};

const result = await createIndex(indexData);
console.log('Created index:', result.index.id);
```

### Python

```python theme={null}
import requests

def create_index(index_data):
    url = "https://{customer.name}.hiperai.ai/api/external/indexes"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here",
        "Content-Type": "application/json"
    }
    
    response = requests.post(url, headers=headers, json=index_data)
    return response.json()

# Example usage
index_data = {
    "name": "my-knowledge-base",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24",
    "region": "us-east-1",
    "cloud": "aws"
}

result = create_index(index_data)
print("Created index:", result["index"]["id"])
```

### cURL

```bash theme={null}
curl -X POST "https://{customer.name}.hiperai.ai/api/external/indexes" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-knowledge-base",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24",
    "region": "us-east-1",
    "cloud": "aws"
  }'
```

## Error Responses

### 400 Bad Request

```json theme={null}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Index name is required",
    "details": {
      "field": "name",
      "value": null
    }
  }
}
```

## Validations and Business Rules

* **Index name normalization** (for storage and uniqueness checks):
  * Lowercase, trim whitespace
  * Replace spaces with hyphens
  * Remove any character not in `[a-z0-9-]`
* **Index name validation**: Must match `^[a-z0-9-]{3,50}$`; otherwise returns 400.
* **Uniqueness**: Normalized `name` must be unique; duplicates return 409.
* **Assigned user quota**: If `assignedUser` is provided, enforce user index quota via `checkUserIndexQuota`; exceeded quota returns 403.
* **Region restriction (Essential)**: For `Essential` license, indexes can only be created with `cloud=aws` and `region=us-east-1`; otherwise 403.
* **Assigned group**: When `assignedGroup` is provided, the group must exist and not be archived (`status != 'Archived'`); otherwise 400.

## Normalization and Storage

* `name` is stored normalized.
* `sharedIndexName` defaults to the normalized `name`.
* `namespace` defaults to `user-{userId}-index-{normalizedName}` when assigned to a user.

## Typical Error Shapes

### 400 Invalid Index Name

```json theme={null}
{
  "success": false,
  "error": "Invalid index name",
  "message": "Index name must be 3-50 chars, lowercase letters, digits, or hyphens"
}
```

### 403 Index Quota Exceeded

```json theme={null}
{
  "success": false,
  "error": "Index quota exceeded",
  "message": "User has reached the maximum number of indexes for Growth license (current/limit)."
}
```

### 403 Region Not Allowed

```json theme={null}
{
  "success": false,
  "error": "Region not allowed for license",
  "message": "Essential plan is restricted to AWS us-east-1. Please choose cloud=aws and region=us-east-1."
}
```

### 400 Group Invalid/Inactive

```json theme={null}
{
  "success": false,
  "error": "Invalid or inactive group",
  "message": "The specified group does not exist or is not active"
}
```

### 401 Unauthorized

```json theme={null}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
```

### 403 Forbidden

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Cannot create general indexes without admin privileges"
  }
}
```

### 409 Conflict

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INDEX_NAME_EXISTS",
    "message": "Index name already exists"
  }
}
```

### 429 Too Many Requests

```json theme={null}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}
```

## Index Types

| Type       | Description                       | Permissions Required |
| ---------- | --------------------------------- | -------------------- |
| `personal` | Personal index for individual use | Admin privileges     |
| `general`  | Shared organizational index       | Admin privileges     |
| `group`    | Group-assigned index              | Admin privileges     |

## Required Fields

| Field    | Description    | Example             |
| -------- | -------------- | ------------------- |
| `name`   | Index name     | "my-knowledge-base" |
| `region` | AWS region     | "us-east-1"         |
| `cloud`  | Cloud provider | "aws"               |

## Use Cases

* **User Assignment**: Create indexes and assign them to specific users
* **Group Assignment**: Create indexes and assign them to groups
* **Knowledge Bases**: Build specialized knowledge bases for specific domains
* **Content Organization**: Organize content by topic or category
* **Vector Storage**: Create indexes for storing and retrieving vector embeddings

## Rate Limits

* **Default**: 50 requests per minute
* **Daily**: 5,000 requests per day
* **Monthly**: 150,000 requests per month

## Notes

* This endpoint is only accessible by administrators
* Required fields: name, region, cloud are all required
* Assignment: Index can be assigned to a user (assignedUser) or group (assignedGroup)
* Auto-generation: namespace is auto-generated if not provided
* Unique Names: Index names must be unique across the system
* The index is immediately available for use after creation
* Dimension: Vector dimension is managed internally by the application (currently 4096)
* Metric: Similarity metric is managed internally by the application


## OpenAPI

````yaml POST /indexes/all
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/all:
    post:
      tags:
        - Index Management
      summary: Create New Index
      description: >
        Create a new knowledge base index. Only accessible by administrators.

        Note: Vector dimension and metric are managed by the system and not
        configurable via API (dimension: 4096, metric: cosine).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - region
                - cloud
              properties:
                name:
                  type: string
                  description: Index name
                  example: my-knowledge-base
                region:
                  type: string
                  description: >-
                    AWS/GCP region for the vector database (e.g., "us-east-1",
                    "us-west-1")
                  example: us-east-1
                cloud:
                  type: string
                  description: Cloud provider ("aws" or "gcp")
                  enum:
                    - aws
                    - gcp
                  example: aws
                assignedUser:
                  type: string
                  description: User ID to assign the index to (MongoDB ObjectId)
                  example: 60a7c8f5e8b4f5001f7a8c24
                assignedGroup:
                  type: string
                  description: Group ID to assign the index to (MongoDB ObjectId)
                  example: 60a7c8f5e8b4f5001f7a8c25
                sharedIndexName:
                  type: string
                  description: Shared index name (optional, defaults to name)
                  example: my-knowledge-base
                namespace:
                  type: string
                  description: Namespace for the index (optional, auto-generated)
                  example: user-60a7c8f5e8b4f5001f7a8c24-index-my-knowledge-base
            example:
              name: my-knowledge-base
              region: us-east-1
              cloud: aws
              assignedUser: 60a7c8f5e8b4f5001f7a8c24
              sharedIndexName: my-knowledge-base
      responses:
        '201':
          description: Index created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Index created successfully
                  index:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 60a7c8f5e8b4f5001f7a8c23
                      name:
                        type: string
                        example: my-knowledge-base
                      sharedIndexName:
                        type: string
                        example: my-knowledge-base
                      namespace:
                        type: string
                        example: user-60a7c8f5e8b4f5001f7a8c24-index-my-knowledge-base
                      type:
                        type: string
                        enum:
                          - personal
                          - general
                          - group
                          - unknown
                        example: personal
                      assignedUser:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            example: 60a7c8f5e8b4f5001f7a8c24
                          name:
                            type: string
                            example: John Doe
                          email:
                            type: string
                            example: john@example.com
                      assignedGroup:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            example: 60a7c8f5e8b4f5001f7a8c25
                          name:
                            type: string
                            example: Engineering Team
                      createdAt:
                        type: string
                        format: date-time
                        example: '2024-01-15T10:30:00.000Z'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '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'
        '409':
          description: Index name already exists
          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`

````