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

# Créer un index

> Créer un nouvel index de base de connaissances

# Créer un index

Créez un nouvel index de base de connaissances pour stocker et récupérer des documents.

## Point de terminaison

```
POST /indexes
```

## Description

Ce point de terminaison permet aux administrateurs de créer un nouvel index de base de connaissances. L'index peut être attribué à des utilisateurs ou à des groupes spécifiques. Seuls les administrateurs peuvent créer des index.

## Authentification

**Obligatoire** : clé API avec privilèges d'administrateur

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

## Corps de la demande

| Paramètre         | Tapez  | Obligatoire | Descriptif                                                                 |
| ----------------- | ------ | ----------- | -------------------------------------------------------------------------- |
| `name`            | chaîne | Oui         | Nom de l'index                                                             |
| `assignedUser`    | chaîne | Non         | ID utilisateur auquel attribuer l'index (MongoDB ObjectId)                 |
| `assignedGroup`   | chaîne | Non         | ID de groupe auquel attribuer l'index (MongoDB ObjectId)                   |
| `sharedIndexName` | chaîne | Non         | Nom de l'index partagé (nom par défaut)                                    |
| `namespace`       | chaîne | Non         | Espace de noms pour l'index (généré automatiquement s'il n'est pas fourni) |
| `region`          | chaîne | Non         | Astuce de région pour le stockage (facultatif)                             |
| `cloud`           | chaîne | Non         | Astuce du fournisseur de cloud (facultatif)                                |

## Exemple de demande

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

## Réponse réussie

**Code d'état** : `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"
  }
}
```

### Champs de réponse

| Champ                   | Tapez   | Descriptif                                            |
| ----------------------- | ------- | ----------------------------------------------------- |
| `success`               | booléen | Indique si l'opération a réussi                       |
| `message`               | chaîne  | Message de réussite                                   |
| `index`                 | objet   | Objet d'index créé                                    |
| `index.id`              | chaîne  | Identificateur d'index unique                         |
| `index.name`            | chaîne  | Nom de l'index                                        |
| `index.sharedIndexName` | chaîne  | Nom de l'index partagé                                |
| `index.namespace`       | chaîne  | Espace de noms d'index                                |
| `index.type`            | chaîne  | Type d'index (personnel, général, groupe, inconnu)    |
| `index.assignedUser`    | objet   | Informations utilisateur attribuées (si personnelles) |
| `index.assignedGroup`   | objet   | Informations sur le groupe attribué (si groupe)       |
| `index.createdAt`       | chaîne  | Horodatage de création                                |

## Exemple d'utilisation

\###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"])
```

### boucle

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

## Réponses d'erreur

### 400 Requête incorrecte

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

## Validations et règles métier

* **Normalisation du nom d'index** (pour les contrôles de stockage et d'unicité) :
  * Minuscules, couper les espaces
  * Remplacer les espaces par des tirets
  * Supprimer tout caractère ne figurant pas dans `[a-z0-9-]`
* **Validation du nom de l'index** : doit correspondre à `^[a-z0-9-]{3,50}$` ; sinon, renvoie 400.
* **Unicité** : `name` normalisé doit être unique ; les doublons renvoient 409.
* **Quota d'utilisateur attribué** : si `assignedUser` est fourni, appliquez le quota d'index utilisateur via `checkUserIndexQuota` ; le dépassement du quota renvoie 403.
* **Restriction régionale (essentielle)** : pour la licence `Essential`, les index ne peuvent être créés qu'avec `cloud=aws` et `region=us-east-1` ; sinon 403.
* **Groupe attribué** : Lorsque `assignedGroup` est fourni, le groupe doit exister et ne pas être archivé (`status != 'Archived'`) ; sinon 400.

## Normalisation et stockage

* `name` est stocké normalisé.
* `sharedIndexName` est par défaut le `name` normalisé.
* `namespace` est par défaut `user-{userId}-index-{normalizedName}` lorsqu'il est attribué à un utilisateur.

## Formes d'erreur typiques

### 400 Nom d'index invalide

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

### 403 Quota d'index dépassé

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

### 403 Région non autorisée

```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 Groupe invalide/inactif

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

### 401 Non autorisé

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

### 403 Interdit

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

### 409 Conflit

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

### 429 Trop de demandes

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

## Types d'index

| Tapez      | Descriptif                         | Autorisations requises      |
| ---------- | ---------------------------------- | --------------------------- |
| `personal` | Index personnel à usage individuel | Privilèges d'administrateur |
| `general`  | Index organisationnel partagé      | Privilèges d'administrateur |
| `group`    | Index attribué au groupe           | Privilèges d'administrateur |

## Champs obligatoires

| Champ    | Descriptif           | Exemple                    |
| -------- | -------------------- | -------------------------- |
| `name`   | Nom de l'index       | "ma-base-de-connaissances" |
| `region` | Région AWS           | "nous-est-1"               |
| `cloud`  | Fournisseur de cloud | "aws"                      |

## Cas d'utilisation

* **Affectation d'utilisateur** : créez des index et attribuez-les à des utilisateurs spécifiques
* **Affectation de groupe** : créez des index et attribuez-les à des groupes
* **Bases de connaissances** : créez des bases de connaissances spécialisées pour des domaines spécifiques
* **Organisation du contenu** : organisez le contenu par sujet ou par catégorie
* **Stockage vectoriel** : créez des index pour stocker et récupérer des intégrations vectorielles

## Limites de taux

* **Par défaut** : 50 requêtes par minute
* **Quotidien** : 5 000 requêtes par jour
* **Mensuel** : 150 000 demandes par mois

## Remarques

* Ce point de terminaison n'est accessible que par les administrateurs
* Champs obligatoires : nom, région, cloud sont tous obligatoires
* Affectation : l'index peut être attribué à un utilisateur (assignedUser) ou à un groupe (assignedGroup)
* Génération automatique : l'espace de noms est généré automatiquement s'il n'est pas fourni
* Noms uniques : les noms d'index doivent être uniques dans tout le système.
* L'index est immédiatement disponible pour utilisation après sa création
* Dimension : La dimension vectorielle est gérée en interne par l'application (actuellement 4096)
* Métrique : la métrique de similarité est gérée en interne par l'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`

````