API-Referenz

Die SecureAI External API bietet KI-Chat-Abschlussfunktionen mit Wissensdatenbankabruf, Sicherheitsrichtlinien und umfassender Nutzungsverfolgung. Diese API ist für externe Entwickler und Integrationen konzipiert, die eine API-Schlüsselauthentifizierung verwenden.

Hauptmerkmale

RAG (Retrieval-Augmented Generation): Wissensdatenbanken automatisch nach relevantem Kontext durchsuchen
Unterstützung mehrerer Modelle: OpenAI, Anthropic, Google, Meta und andere KI-Modelle
Modellredundanz und Failover: Vom Aufrufer definierte Failover-Ketten (primär + Fallbacks) mit Zeitüberschreitungen pro Versuch
OpenAI-kompatibler Endpunkt: Richten Sie ein beliebiges OpenAI SDK auf /api/external/v1 – keine Codeänderungen
Bildgenerierung: Bilder mit Google Gemini 2.5 Flash Image erstellen und bearbeiten
Speech-to-Speech (S2S): Echtzeit-Sprachgespräche mithilfe der OpenAI Realtime API mit WebRTC
Sicherheitsrichtlinien: SMLTP-Richtliniendurchsetzung, Prompt Shield pro Anruf und signierte Compliance-Belege
Webhooks: Signierte Bereitstellung von Sicherheits- und Plattformereignissen in Echtzeit
Nutzungsverfolgung: Umfassende Nutzungsüberwachung, Self-Service-Kontingent und Ratenbegrenzung
Wissensdatenbank-Integration: Zugriff auf persönliche und gemeinsame Wissensdatenbanken
Benutzerverwaltung: Vollständige Benutzer-, Gruppen- und Rollenverwaltungsfunktionen
Audit-Protokollierung: Umfassende Aktivitäts- und Sicherheits-Audit-Protokolle

Authentifizierung

Alle Endpunkte (außer Integritätsprüfung) erfordern eine API-Schlüsselauthentifizierung mithilfe eines Bearer-Tokens:

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

Basis-URL

https://{customer.name}.hiperai.ai/api/external

Für die OpenAI-kompatible Oberfläche geben Sie die Basis-URL Ihres SDKs an:

https://{customer.name}.hiperai.ai/api/external/v1

Abrechnung und Nutzung

Standardmäßig werden API-Anfragen dem Benutzerkonto in Rechnung gestellt, das den API-Schlüssel besitzt. Sie können einen anderen Benutzer für die Abrechnung angeben, indem Sie den Parameter user_id in Ihre Anfrage aufnehmen. Dies ermöglicht:

Mandantenfähige Anwendungen mit Abrechnung pro Benutzer
Flexibles Abschlusslimitmanagement
Benutzerspezifische „Nutzung nach Modell“-Einstellungen

Tarifbegrenzungen

Standard: 60 Anfragen pro Minute, 1000 Anfragen pro Stunde
Tageslimits: 100 Anfragen (konfigurierbar)
Monatliche Limits: 10.000 Anfragen (konfigurierbar)

Schnellstart

1. Gesundheitscheck

curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"

2. Verfügbare Modelle abrufen

curl -X GET "https://{customer.name}.hiperai.ai/api/external/models" \
  -H "Authorization: Bearer sk-your-api-key-here"

3. Erhalten Sie verfügbare Wissensdatenbanken

curl -X GET "https://{customer.name}.hiperai.ai/api/external/indexes" \
  -H "Authorization: Bearer sk-your-api-key-here"

4. Erstellen Sie einen Chat-Abschluss

curl -X POST "https://{customer.name}.hiperai.ai/api/external/chat/completions" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5-nano",
    "index": "my-knowledge-base",
    "smltp_policy": "internal",
    "prompt": "What is the company policy on remote work?",
    "temperature": 0.7,
    "max_tokens": 1000,
    "stream": false
  }'

API-Endpunkte

System

Health Check - API-Status prüfen

Entdeckung

Verfügbare Modelle abrufen – Verfügbare KI-Modelle auflisten
Verfügbare Wissensdatenbanken abrufen - Verfügbare Wissensdatenbanken auflisten
Sicherheitsrichtlinien abrufen - Verfügbare SMLTP-Richtlinien auflisten

Chatten

Chat Completion – Haupt-KI-Chat-Endpunkt mit RAG
OpenAI-kompatibler Endpunkt - Drop-in /v1/chat/completions für OpenAI SDKs
Redundanz & Failover - Failover-Ketten modellieren
Policy Check - Führen Sie einen Probelauf der Sicherheitspipeline durch, ohne ein Modell aufzurufen
Nutzung – Self-Service-Kontingent, Budget und Ratenlimits
Receipts - Signierte SMLTP-Konformitätsbelege abrufen

Webhooks

Webhooks-Übersicht - Signierte Echtzeit-Ereigniszustellung
Webhook Events - Eventkatalog und Payloads

Bilder

Bilder generieren - Bilder aus Text generieren oder vorhandene Bilder bearbeiten
Bilder bearbeiten - Bild-zu-Bild-Bearbeitung mit Textanweisungen

Sprache/S2S

S2S WebRTC-Sitzung initiieren - Sprachgespräche in Echtzeit aufbauen
S2S-Zeitstatus abrufen - Überprüfen Sie das verbleibende S2S-Zeitkontingent
S2S-Sitzungsdauer protokollieren - Sitzungsdauer und Abzugszeit protokollieren

Benutzerverwaltung

Alle Benutzer abrufen - Benutzer mit Paginierung abrufen
Benutzer erstellen - Neues Benutzerkonto erstellen
Benutzer aktualisieren - Bestehenden Benutzer aktualisieren
Lizenzverfügbarkeit abrufen - Lizenzpoollimits und -nutzung abrufen

Indexverwaltung

Alle Indizes abrufen - Alle Wissensdatenbanken abrufen
Index erstellen - Neue Wissensdatenbank erstellen
Index aktualisieren - Bestehenden Index aktualisieren
Index mit Dokumenten trainieren - Index durch Hochladen von Dokumenten trainieren
Suchindex für Dokumente - Suche nach Dokumenten mittels semantischer Suche

Gruppenmanagement

Alle Gruppen abrufen - Alle Gruppen abrufen
Gruppe erstellen - Neue Gruppe erstellen
Gruppe aktualisieren - Bestehende Gruppe aktualisieren

SMLTP-Sicherheit

Alle SMLTP-Richtlinien abrufen - Alle Sicherheitsrichtlinien auflisten
Aktive Richtlinie abrufen - Aktuelle aktive Richtlinie abrufen
Benutzerdefinierte Richtlinie erstellen - Benutzerdefinierte SMLTP-Richtlinie erstellen
Audit-Logs – SMLTP-Audit-Logs abrufen

Rollenverwaltung

Alle Rollen abrufen - Alle Rollen abrufen
Rolle erstellen - Neue benutzerdefinierte Rolle erstellen

Fehlerbehandlung

Fehlerantwortformat

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

Ratenbegrenzungsfehler

{
  "success": false,
  "error": "Rate limit exceeded",
  "message": "Please reduce your request rate",
  "reset_time": "2024-01-15T11:00:00.000Z"
}

Allgemeine HTTP-Statuscodes

Code	Beschreibung
`200`	Erfolg
`201`	Erfolgreich erstellt
`400`	Fehlerhafte Anfrage – ungültige Parameter
`401`	Nicht autorisiert – ungültiger API-Schlüssel
`403`	Verboten – unzureichende Berechtigungen
`404`	Nicht gefunden
`409`	Konflikt – Ressource existiert bereits
`413`	Nutzlast zu groß – Dateigröße überschritten
`429`	Ratenlimit überschritten
`500`	Interner Serverfehler
`503`	Dienst nicht verfügbar – Dienst nicht konfiguriert

SDK-Beispiele

JavaScript/Node.js

// Using fetch
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/chat/completions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model: 'openai/gpt-5-nano',
    index: 'my-knowledge-base',
    smltp_policy: 'internal',
    prompt: 'What is the company policy on remote work?',
    temperature: 0.7,
    max_tokens: 1000
  })
});

const data = await response.json();
console.log(data.choices[0].message.content);

Python

import requests

url = "https://{customer.name}.hiperai.ai/api/external/chat/completions"
headers = {
    "Authorization": "Bearer sk-your-api-key-here",
    "Content-Type": "application/json"
}
data = {
  "model": "openai/gpt-5-nano",
    "index": "my-knowledge-base",
    "smltp_policy": "internal",
    "prompt": "What is the company policy on remote work?",
    "temperature": 0.7,
    "max_tokens": 1000
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result['choices'][0]['message']['content'])

cURL

curl -X POST "https://{customer.name}.hiperai.ai/api/external/chat/completions" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5-nano",
    "index": "my-knowledge-base",
    "smltp_policy": "internal",
    "prompt": "What is the company policy on remote work?",
    "temperature": 0.7,
    "max_tokens": 1000

2. Verfügbare Modelle abrufen

curl -X GET "https://{customer.name}.hiperai.ai/api/external/models" \
  -H "Authorization: Bearer sk-your-api-key-here"

3. Erhalten Sie verfügbare Wissensdatenbanken

curl -X GET "https://{customer.name}.hiperai.ai/api/external/indexes" \
  -H "Authorization: Bearer sk-your-api-key-here"

4. Erstellen Sie einen Chat-Abschluss

curl -X POST "https://{customer.name}.hiperai.ai/api/external/chat/completions" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5-nano",
    "index": "my-knowledge-base",
    "smltp_policy": "internal",
    "prompt": "What is the company policy on remote work?",
    "temperature": 0.7,
    "max_tokens": 1000,
    "stream": false
  }'

API-Endpunkte

System

Health Check - API-Status prüfen

Entdeckung

Verfügbare Modelle abrufen – Verfügbare KI-Modelle auflisten
Verfügbare Wissensdatenbanken abrufen - Verfügbare Wissensdatenbanken auflisten
Sicherheitsrichtlinien abrufen - Verfügbare SMLTP-Richtlinien auflisten

Chatten

Chat Completion – Haupt-KI-Chat-Endpunkt mit RAG
OpenAI-kompatibler Endpunkt - Drop-in /v1/chat/completions für OpenAI SDKs
Redundanz & Failover - Failover-Ketten modellieren
Policy Check - Führen Sie einen Probelauf der Sicherheitspipeline durch, ohne ein Modell aufzurufen
Nutzung – Self-Service-Kontingent, Budget und Ratenlimits
Receipts - Signierte SMLTP-Konformitätsbelege abrufen

Webhooks

Webhooks-Übersicht - Signierte Echtzeit-Ereigniszustellung
Webhook Events - Eventkatalog und Payloads

Bilder

Bilder generieren - Bilder aus Text generieren oder vorhandene Bilder bearbeiten
Bilder bearbeiten - Bild-zu-Bild-Bearbeitung mit Textanweisungen

Sprache/S2S

S2S WebRTC-Sitzung initiieren - Sprachgespräche in Echtzeit aufbauen
S2S-Zeitstatus abrufen - Überprüfen Sie das verbleibende S2S-Zeitkontingent
S2S-Sitzungsdauer protokollieren - Sitzungsdauer und Abzugszeit protokollieren

Benutzerverwaltung

Alle Benutzer abrufen - Benutzer mit Paginierung abrufen
Benutzer erstellen - Neues Benutzerkonto erstellen
Benutzer aktualisieren - Bestehenden Benutzer aktualisieren
Lizenzverfügbarkeit abrufen - Lizenzpoollimits und -nutzung abrufen

Indexverwaltung

Alle Indizes abrufen - Alle Wissensdatenbanken abrufen
Index erstellen - Neue Wissensdatenbank erstellen
Index aktualisieren - Bestehenden Index aktualisieren
Index mit Dokumenten trainieren - Index durch Hochladen von Dokumenten trainieren
Suchindex für Dokumente - Suche nach Dokumenten mittels semantischer Suche

Gruppenmanagement

Alle Gruppen abrufen - Alle Gruppen abrufen
Gruppe erstellen - Neue Gruppe erstellen
Gruppe aktualisieren - Bestehende Gruppe aktualisieren

SMLTP-Sicherheit

Alle SMLTP-Richtlinien abrufen - Alle Sicherheitsrichtlinien auflisten
Aktive Richtlinie abrufen - Aktuelle aktive Richtlinie abrufen
Benutzerdefinierte Richtlinie erstellen - Benutzerdefinierte SMLTP-Richtlinie erstellen
Audit-Logs – SMLTP-Audit-Logs abrufen

Rollenverwaltung

Alle Rollen abrufen - Alle Rollen abrufen
Rolle erstellen - Neue benutzerdefinierte Rolle erstellen

Fehlerbehandlung

Fehlerantwortformat

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

Ratenbegrenzungsfehler

{
  "success": false,
  "error": "Rate limit exceeded",
  "message": "Please reduce your request rate",
  "reset_time": "2024-01-15T11:00:00.000Z"
}

Allgemeine HTTP-Statuscodes

Code	Beschreibung
`200`	Erfolg
`201`	Erfolgreich erstellt
`400`	Fehlerhafte Anfrage – ungültige Parameter
`401`	Nicht autorisiert – ungültiger API-Schlüssel
`403`	Verboten – unzureichende Berechtigungen
`404`	Nicht gefunden
`409`	Konflikt – Ressource existiert bereits
`413`	Nutzlast zu groß – Dateigröße überschritten
`429`	Ratenlimit überschritten
`500`	Interner Serverfehler
`503`	Dienst nicht verfügbar – Dienst nicht konfiguriert

SDK-Beispiele

JavaScript/Node.js

// Using fetch
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/chat/completions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model: 'openai/gpt-5-nano',
    index: 'my-knowledge-base',
    smltp_policy: 'internal',
    prompt: 'What is the company policy on remote work?',
    temperature: 0.7,
    max_tokens: 1000
  })
});

const data = await response.json();
console.log(data.choices[0].message.content);

Python

import requests

url = "https://{customer.name}.hiperai.ai/api/external/chat/completions"
headers = {
    "Authorization": "Bearer sk-your-api-key-here",
    "Content-Type": "application/json"
}
data = {
  "model": "openai/gpt-5-nano",
    "index": "my-knowledge-base",
    "smltp_policy": "internal",
    "prompt": "What is the company policy on remote work?",
    "temperature": 0.7,
    "max_tokens": 1000
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result['choices'][0]['message']['content'])

cURL

curl -X POST "https://{customer.name}.hiperai.ai/api/external/chat/completions" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5-nano",
    "index": "my-knowledge-base",
    "smltp_policy": "internal",
    "prompt": "What is the company policy on remote work?",
    "temperature": 0.7,
    "max_tokens": 1000
  }'

Nächste Schritte

Knowledge Base & RAG - Erfahren Sie mehr über Knowledge Bases und RAG „

​API-Referenz

​Hauptmerkmale

​Authentifizierung

​Basis-URL

​Abrechnung und Nutzung

​Tarifbegrenzungen

​Schnellstart

​1. Gesundheitscheck

​2. Verfügbare Modelle abrufen

​3. Erhalten Sie verfügbare Wissensdatenbanken

​4. Erstellen Sie einen Chat-Abschluss

​API-Endpunkte

​System

​Entdeckung

​Chatten

​Webhooks

​Bilder

​Sprache/S2S

​Benutzerverwaltung

​Indexverwaltung

​Gruppenmanagement

​SMLTP-Sicherheit

​Rollenverwaltung

​Fehlerbehandlung

​Fehlerantwortformat

​Ratenbegrenzungsfehler

​Allgemeine HTTP-Statuscodes

​SDK-Beispiele

​JavaScript/Node.js

​Python

​cURL

​2. Verfügbare Modelle abrufen

​3. Erhalten Sie verfügbare Wissensdatenbanken

​4. Erstellen Sie einen Chat-Abschluss

​API-Endpunkte

​System

​Entdeckung

​Chatten

​Webhooks

​Bilder

​Sprache/S2S

​Benutzerverwaltung

​Indexverwaltung

​Gruppenmanagement

​SMLTP-Sicherheit

​Rollenverwaltung

​Fehlerbehandlung

​Fehlerantwortformat

​Ratenbegrenzungsfehler

​Allgemeine HTTP-Statuscodes

​SDK-Beispiele

​JavaScript/Node.js

​Python

​cURL

​Nächste Schritte

API-Referenz

Hauptmerkmale

Authentifizierung

Basis-URL

Abrechnung und Nutzung

Tarifbegrenzungen

Schnellstart

1. Gesundheitscheck

2. Verfügbare Modelle abrufen

3. Erhalten Sie verfügbare Wissensdatenbanken

4. Erstellen Sie einen Chat-Abschluss

API-Endpunkte

System

Entdeckung

Chatten

Webhooks

Bilder

Sprache/S2S

Benutzerverwaltung

Indexverwaltung

Gruppenmanagement

SMLTP-Sicherheit

Rollenverwaltung

Fehlerbehandlung

Fehlerantwortformat

Ratenbegrenzungsfehler

Allgemeine HTTP-Statuscodes

SDK-Beispiele

JavaScript/Node.js

Python

cURL

2. Verfügbare Modelle abrufen

3. Erhalten Sie verfügbare Wissensdatenbanken

4. Erstellen Sie einen Chat-Abschluss

API-Endpunkte

System

Entdeckung

Chatten

Webhooks

Bilder

Sprache/S2S

Benutzerverwaltung

Indexverwaltung

Gruppenmanagement

SMLTP-Sicherheit

Rollenverwaltung

Fehlerbehandlung

Fehlerantwortformat

Ratenbegrenzungsfehler

Allgemeine HTTP-Statuscodes

SDK-Beispiele

JavaScript/Node.js

Python

cURL

Nächste Schritte