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

> Aktualisieren Sie einen vorhandenen Wissensdatenbankindex

# Index aktualisieren

Aktualisieren Sie einen vorhandenen Wissensdatenbankindex mit neuen Einstellungen, Metadaten oder Konfigurationen.

## Endpunkt

```
PUT /indexes/{indexId}
```

## Beschreibung

Mit diesem Endpunkt können Administratoren einen vorhandenen Wissensdatenbankindex aktualisieren. Sie können den Indexnamen ändern und ihn anderen Benutzern oder Gruppen neu zuweisen. Nur Administratoren können Indizes aktualisieren.

## Authentifizierung

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

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

## Pfadparameter

| Parameter | Geben Sie    | ein Erforderlich | Beschreibung                                            |
| --------- | ------------ | ---------------- | ------------------------------------------------------- |
| `indexId` | Zeichenfolge | Ja               | Der eindeutige Bezeichner des zu aktualisierenden Index |

## Anforderungstext

| Parameter       | Geben Sie    | ein Erforderlich | Beschreibung                                                         |
| --------------- | ------------ | ---------------- | -------------------------------------------------------------------- |
| `name`          | Zeichenfolge | Nein             | Neuer Name für den Index                                             |
| `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)  |

## Beispielanfrage

```json theme={null}
{
  "name": "updated-knowledge-base",
  "assignedUser": "60a7c8f5e8b4f5001f7a8c24"
}
```

## Erfolgsantwort

**Statuscode**: `200 OK`

```json theme={null}
{
  "success": true,
  "message": "Index updated successfully",
  "index": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "updated-knowledge-base",
    "sharedIndexName": "updated-knowledge-base",
    "namespace": "user-60a7c8f5e8b4f5001f7a8c24-index-updated-knowledge-base",
    "type": "personal",
    "assignedUser": {
      "id": "60a7c8f5e8b4f5001f7a8c24",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "assignedGroup": null,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "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          | Aktualisiertes Indexobjekt                                 |
| `index.id`              | Zeichenfolge    | Eindeutiger Indexbezeichner                                |
| `index.name`            | Zeichenfolge    | Aktualisierter 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    | Ursprünglicher Erstellungszeitstempel                      |
| `index.updatedAt`       | Zeichenfolge    | Zeitstempel der letzten Aktualisierung                     |

## Beispielverwendung

### JavaScript

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

// Example usage
const updateData = {
  name: "updated-knowledge-base",
  assignedUser: "60a7c8f5e8b4f5001f7a8c24"
};

const result = await updateIndex('60a7c8f5e8b4f5001f7a8c23', updateData);
console.log('Updated index:', result.index);
```

### Python

```python theme={null}
import requests

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

# Example usage
update_data = {
    "name": "updated-knowledge-base",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24"
}

result = update_index("60a7c8f5e8b4f5001f7a8c23", update_data)
print("Updated index:", result["index"])
```

### cURL

```bash theme={null}
curl -X PUT "https://{customer.name}.hiperai.ai/api/external/indexes/60a7c8f5e8b4f5001f7a8c23" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "updated-knowledge-base",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24"
  }'
```

## Fehlerantworten

### 400 Ungültige Anfrage

```json theme={null}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Index name already exists or invalid assigned IDs",
    "details": {
      "field": "name | assignedUser | assignedGroup"
    }
  }
}
```

## Validierungen und Geschäftsregeln

* **Zuweisung an einen Benutzer (`assignedUser`)**:
  * Erzwingen Sie die Benutzerindexkontingente über `checkUserIndexQuota`, wenn Sie in einen persönlichen Index konvertieren oder den Beauftragten ändern. Überschrittenes Kontingent gibt 403 zurück.
* **Zu einer Gruppe zuweisen (`assignedGroup`)**:
  * Gruppe muss existieren und aktiv sein (`status != 'Archived'`); Ungültige/inaktive Gruppen geben 400 zurück.

## Normalisierung und Speicherung

* Beim Umbenennen wird `name` weiterhin normalisiert gespeichert; `sharedIndexName` verwendet standardmäßig den normalisierten Namen, wenn er nicht explizit festgelegt wird.

## Typische Fehlerformen

### 403 Indexkontingent überschritten

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

### 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 update this index"
  }
}
```

### 404 Nicht gefunden

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INDEX_NOT_FOUND",
    "message": "Index not found"
  }
}
```

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

## Aktualisierbare Felder

| Feld            | Beschreibung      | Notizen                                        |
| --------------- | ----------------- | ---------------------------------------------- |
| `name`          | Indexname         | Muss im gesamten System eindeutig sein         |
| `assignedUser`  | Benutzerzuordnung | Weist einem bestimmten Benutzer einen Index zu |
| `assignedGroup` | Gruppenzuordnung  | Weist den Index einer bestimmten Gruppe zu     |

## Anwendungsfälle

* **Namensänderungen**: Indizes zur besseren Organisation umbenennen
* **Benutzerzuweisung**: Indizes verschiedenen Benutzern neu zuweisen
* **Gruppenzuweisung**: Indizes verschiedenen Gruppen neu zuweisen
* **Eigentumsübertragung**: Indexeigentum zwischen Benutzern ändern

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

* Eingeschränkte Felder: Nur Name, zugewiesener Benutzer und zugewiesene Gruppe können aktualisiert werden
* Zuweisungslogik: Durch die Zuweisung zu einem Benutzer wird die Gruppenzuweisung gelöscht und umgekehrt
* Validierung: Benutzer- und Gruppen-IDs werden vor der Zuweisung validiert
* Keine Einstellungen: Einstellungen, Metadaten oder andere Konfigurationen können nicht aktualisiert werden
  – Der `updatedAt`-Zeitstempel wird automatisch aktualisiert
* Indexnamen müssen im gesamten System eindeutig bleiben


## OpenAPI

````yaml PUT /indexes/{indexId}
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/{indexId}:
    put:
      tags:
        - Index Management
      summary: Update Index
      description: >
        Update an existing index (assign to user or group). Only accessible by
        administrators.
      parameters:
        - name: indexId
          in: path
          required: true
          description: Index ID to update
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Index name
                  example: updated-knowledge-base
                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
            example:
              name: updated-knowledge-base
              assignedUser: 60a7c8f5e8b4f5001f7a8c24
      responses:
        '200':
          description: Index updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Index updated successfully
                  index:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 60a7c8f5e8b4f5001f7a8c23
                      name:
                        type: string
                        example: updated-knowledge-base
                      sharedIndexName:
                        type: string
                        example: updated-knowledge-base
                      namespace:
                        type: string
                        example: >-
                          user-60a7c8f5e8b4f5001f7a8c24-index-updated-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-01T00:00:00.000Z'
                      updatedAt:
                        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'
        '404':
          description: Index not found
          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`

````