Create New Index

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/indexes/all \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-knowledge-base",
  "region": "us-east-1",
  "cloud": "aws",
  "assignedUser": "60a7c8f5e8b4f5001f7a8c24",
  "sharedIndexName": "my-knowledge-base"
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/indexes/all"

payload = {
    "name": "my-knowledge-base",
    "region": "us-east-1",
    "cloud": "aws",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24",
    "sharedIndexName": "my-knowledge-base"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'my-knowledge-base',
    region: 'us-east-1',
    cloud: 'aws',
    assignedUser: '60a7c8f5e8b4f5001f7a8c24',
    sharedIndexName: 'my-knowledge-base'
  })
};

fetch('https://secureai.hiperai.ai/api/external/indexes/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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": {
      "id": "60a7c8f5e8b4f5001f7a8c25",
      "name": "Engineering Team"
    },
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

POST

indexes

all

Create New Index

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/indexes/all \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-knowledge-base",
  "region": "us-east-1",
  "cloud": "aws",
  "assignedUser": "60a7c8f5e8b4f5001f7a8c24",
  "sharedIndexName": "my-knowledge-base"
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/indexes/all"

payload = {
    "name": "my-knowledge-base",
    "region": "us-east-1",
    "cloud": "aws",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24",
    "sharedIndexName": "my-knowledge-base"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'my-knowledge-base',
    region: 'us-east-1',
    cloud: 'aws',
    assignedUser: '60a7c8f5e8b4f5001f7a8c24',
    sharedIndexName: 'my-knowledge-base'
  })
};

fetch('https://secureai.hiperai.ai/api/external/indexes/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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": {
      "id": "60a7c8f5e8b4f5001f7a8c25",
      "name": "Engineering Team"
    },
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

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

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

Erfolgsantwort

Statuscode: 201 Created

{
  "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

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

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

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

{
  "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

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

403 Indexkontingent überschritten

{
  "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

{
  "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

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

401 Nicht autorisiert

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Verboten

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Cannot create general indexes without admin privileges"
  }
}

409 Konflikt

{
  "success": false,
  "error": {
    "code": "INDEX_NAME_EXISTS",
    "message": "Index name already exists"
  }
}

429 Zu viele Anfragen

{
  "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

Autorisierungen

Authorization

string

header

erforderlich

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Body

application/json

name

string

erforderlich

Index name

Beispiel:

"my-knowledge-base"

region

string

erforderlich

AWS/GCP region for the vector database (e.g., "us-east-1", "us-west-1")

Beispiel:

"us-east-1"

cloud

enum<string>

erforderlich

Cloud provider ("aws" or "gcp")

Verfügbare Optionen:

aws,

gcp

Beispiel:

"aws"

assignedUser

string

User ID to assign the index to (MongoDB ObjectId)

Beispiel:

"60a7c8f5e8b4f5001f7a8c24"

assignedGroup

string

Group ID to assign the index to (MongoDB ObjectId)

Beispiel:

"60a7c8f5e8b4f5001f7a8c25"

sharedIndexName

string

Shared index name (optional, defaults to name)

Beispiel:

"my-knowledge-base"

namespace

string

Namespace for the index (optional, auto-generated)

Beispiel:

"user-60a7c8f5e8b4f5001f7a8c24-index-my-knowledge-base"

Antwort

Index created successfully

success

boolean

Beispiel:

true

message

string

Beispiel:

"Index created successfully"

index

object

Show child attributes

Erste Schritte & Setup

Modelle & KI-Generierung

Knowledge Base & RAG

Sicherheit, Guardrails & Auditierung

Benutzer & Zugriff (IAM)

Abrechnung, Kontingente & Webhooks

Index erstellen

Index erstellen

Endpunkt

Beschreibung

Authentifizierung

Anforderungstext

Beispielanfrage

Erfolgsantwort

Antwortfelder

Beispielverwendung

JavaScript

Python

cURL

Fehlerantworten

400 Ungültige Anfrage

Validierungen und Geschäftsregeln

Normalisierung und Speicherung

Typische Fehlerformen

400 Ungültiger Indexname

403 Indexkontingent überschritten

403 Region nicht zulässig

400 Gruppe ungültig/inaktiv

401 Nicht autorisiert

403 Verboten

409 Konflikt

429 Zu viele Anfragen

Indextypen

Erforderliche Felder

Anwendungsfälle

Tarifbegrenzungen

Notizen

Autorisierungen

Body

Antwort

​Index erstellen

​Endpunkt

​Beschreibung

​Authentifizierung

​Anforderungstext

​Beispielanfrage

​Erfolgsantwort

​Antwortfelder

​Beispielverwendung

​JavaScript

​Python

​cURL

​Fehlerantworten

​400 Ungültige Anfrage

​Validierungen und Geschäftsregeln

​Normalisierung und Speicherung

​Typische Fehlerformen

​400 Ungültiger Indexname

​403 Indexkontingent überschritten

​403 Region nicht zulässig

​400 Gruppe ungültig/inaktiv

​401 Nicht autorisiert

​403 Verboten

​409 Konflikt

​429 Zu viele Anfragen

​Indextypen

​Erforderliche Felder

​Anwendungsfälle

​Tarifbegrenzungen

​Notizen

Autorisierungen

Body

Antwort

Index erstellen

Endpunkt

Beschreibung

Authentifizierung

Anforderungstext

Beispielanfrage

Erfolgsantwort

Antwortfelder

Beispielverwendung

JavaScript

Python

cURL

Fehlerantworten

400 Ungültige Anfrage

Validierungen und Geschäftsregeln

Normalisierung und Speicherung

Typische Fehlerformen

400 Ungültiger Indexname

403 Indexkontingent überschritten

403 Region nicht zulässig

400 Gruppe ungültig/inaktiv

401 Nicht autorisiert

403 Verboten

409 Konflikt

429 Zu viele Anfragen

Indextypen

Erforderliche Felder

Anwendungsfälle

Tarifbegrenzungen

Notizen