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

# Index erstellen

> Erstellen Sie einen neuen Wissensdatenbankindex

# Index erstellen

Erstellen Sie einen neuen Wissensdatenbankindex zum Speichern und Abrufen von Dokumenten.

## Endpunkt

```
POST /indexes
```

## Beschreibung

Mit diesem Endpunkt können Administratoren einen neuen Wissensdatenbankindex erstellen. Der Index kann bestimmten Benutzern oder Gruppen zugewiesen werden. Nur Administratoren können Indizes erstellen.

## Authentifizierung

**Erforderlich**: API-Schlüssel mit Administratorrechten

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

## Anforderungstext

| Parameter         | Geben Sie    | ein Erforderlich | Beschreibung                                                           |
| ----------------- | ------------ | ---------------- | ---------------------------------------------------------------------- |
| `name`            | Zeichenfolge | Ja               | Indexname                                                              |
| `assignedUser`    | Zeichenfolge | Nein             | Benutzer-ID, der der Index zugewiesen werden soll (MongoDB ObjectId)   |
| `assignedGroup`   | Zeichenfolge | Nein             | Gruppen-ID, der der Index zugewiesen werden soll (MongoDB ObjectId)    |
| `sharedIndexName` | Zeichenfolge | Nein             | Gemeinsamer Indexname (standardmäßig Name)                             |
| `namespace`       | Zeichenfolge | Nein             | Namespace für den Index (automatisch generiert, falls nicht angegeben) |
| `region`          | Zeichenfolge | Nein             | Regionshinweis für die Speicherung (optional)                          |
| `cloud`           | Zeichenfolge | Nein             | Hinweis zum Cloud-Anbieter (optional)                                  |

## Beispielanfrage

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

## Erfolgsantwort

**Statuscode**: `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"
  }
}
```

### Antwortfelder

| Feld                    | Geben Sie       | ein Beschreibung                                           |
| ----------------------- | --------------- | ---------------------------------------------------------- |
| `success`               | boolescher Wert | Zeigt an, ob der Vorgang erfolgreich war                   |
| `message`               | Zeichenfolge    | Erfolgsmeldung                                             |
| `index`                 | Objekt          | Indexobjekt erstellt                                       |
| `index.id`              | Zeichenfolge    | Eindeutiger Indexbezeichner                                |
| `index.name`            | Zeichenfolge    | Indexname                                                  |
| `index.sharedIndexName` | Zeichenfolge    | Gemeinsamer Indexname                                      |
| `index.namespace`       | Zeichenfolge    | Index-Namespace                                            |
| `index.type`            | Zeichenfolge    | Indextyp (persönlich, allgemein, Gruppe, unbekannt)        |
| `index.assignedUser`    | Objekt          | Zugewiesene Benutzerinformationen (sofern personenbezogen) |
| `index.assignedGroup`   | Objekt          | Zugewiesene Gruppeninformationen (falls Gruppe)            |
| `index.createdAt`       | Zeichenfolge    | Erstellungszeitstempel                                     |

## Beispielverwendung

### 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"
  }'
```

## Fehlerantworten

### 400 Ungültige Anfrage

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

## Validierungen und Geschäftsregeln

* **Normalisierung des Indexnamens** (für Speicher- und Eindeutigkeitsprüfungen):
  * Kleinbuchstaben, Leerzeichen entfernen
  * Ersetzen Sie Leerzeichen durch Bindestriche
  * Entfernen Sie alle Zeichen, die nicht in `[a-z0-9-]` enthalten sind.
* **Indexnamensvalidierung**: Muss mit `^[a-z0-9-]{3,50}$` übereinstimmen; andernfalls wird 400 zurückgegeben.
* **Einzigartigkeit**: Normalisiertes `name` muss eindeutig sein; Duplikate geben 409 zurück.
* **Zugewiesene Benutzerquote**: Wenn `assignedUser` bereitgestellt wird, erzwingen Sie die Benutzerindexquote über `checkUserIndexQuota`; Das überschrittene Kontingent gibt 403 zurück.
* **Regionsbeschränkung (wesentlich)**: Für die Lizenz `Essential` können Indizes nur mit `cloud=aws` und `region=us-east-1` erstellt werden; sonst 403.
* **Zugewiesene Gruppe**: Wenn `assignedGroup` bereitgestellt wird, muss die Gruppe vorhanden sein und darf nicht archiviert werden (`status != 'Archived'`); sonst 400.

## Normalisierung und Speicherung

* `name` wird normalisiert gespeichert.
* `sharedIndexName` verwendet standardmäßig das normalisierte `name`.
* `namespace` ist standardmäßig `user-{userId}-index-{normalizedName}`, wenn es einem Benutzer zugewiesen wird.

## Typische Fehlerformen

### 400 Ungültiger Indexname

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

### 403 Indexkontingent überschritten

```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 nicht zulässig

```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 Gruppe ungültig/inaktiv

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

### 401 Nicht autorisiert

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

### 403 Verboten

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

### 409 Konflikt

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

### 429 Zu viele Anfragen

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

## Indextypen

| Geben Sie  | ein Beschreibung                                  | Erforderliche Berechtigungen |
| ---------- | ------------------------------------------------- | ---------------------------- |
| `personal` | Persönlicher Index für den individuellen Gebrauch | Administratorrechte          |
| `general`  | Gemeinsamer Organisationsindex                    | Administratorrechte          |
| `group`    | Gruppenzugewiesener Index                         | Administratorrechte          |

## Erforderliche Felder

| Feld     | Beschreibung   | Beispiel                 |
| -------- | -------------- | ------------------------ |
| `name`   | Indexname      | „meine-Wissensdatenbank“ |
| `region` | AWS-Region     | „us-east-1“              |
| `cloud`  | Cloud-Anbieter | „aws“                    |

## Anwendungsfälle

* **Benutzerzuweisung**: Erstellen Sie Indizes und weisen Sie sie bestimmten Benutzern zu
* **Gruppenzuweisung**: Indizes erstellen und Gruppen zuweisen
* **Wissensdatenbanken**: Erstellen Sie spezielle Wissensdatenbanken für bestimmte Domänen
* **Inhaltsorganisation**: Organisieren Sie Inhalte nach Thema oder Kategorie
* **Vektorspeicher**: Erstellen Sie Indizes zum Speichern und Abrufen von Vektoreinbettungen

## Tarifbegrenzungen

* **Standard**: 50 Anfragen pro Minute
* **Täglich**: 5.000 Anfragen pro Tag
* **Monatlich**: 150.000 Anfragen pro Monat

## Notizen

– Auf diesen Endpunkt können nur Administratoren zugreifen

* Erforderliche Felder: Name, Region, Cloud sind alle erforderlich
* Zuweisung: Der Index kann einem Benutzer (assignedUser) oder einer Gruppe (assignedGroup) zugewiesen werden.
* Automatische Generierung: Namespace wird automatisch generiert, wenn er nicht angegeben wird
* Eindeutige Namen: Indexnamen müssen im gesamten System eindeutig sein
* Der Index steht nach der Erstellung sofort zur Nutzung zur Verfügung
* Dimension: Die Vektordimension wird intern von der Anwendung verwaltet (derzeit 4096).
* Metrik: Die Ähnlichkeitsmetrik wird intern von der Anwendung verwaltet


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

````