Zum Hauptinhalt springen
Startseite > “Admin-Menü” > “API-Keys”

​
API Keys

API Keys ermöglichen den direkten Zugriff auf Assistenten über die API, um Integrationen in Drittanwendungen wie Chatbots, Helpdesk-Systeme oder Webportale zu realisieren. Damit lassen sich die in VARIOS AI konfigurierten Assistenten nahtlos in bestehende Workflows einbinden.
Info: Die VARIOS AI API ist OpenAI Kompatibel.
Hinweis: Jeder API Key benötigt eine eigene Lizenz. Stellen Sie sicher, dass ausreichend Lizenzen für die geplanten Integrationen vorhanden sind.

​
Funktionen im Überblick

  • Listenansicht: Zeigt alle vorhandenen API Keys mit Namen an. Jeder Key kann bearbeitet oder gelöscht werden.
  • Suche: Ermöglicht das schnelle Auffinden einzelner Keys.
  • Neuer API Key: Über die Schaltfläche „Neuer API-Key“ kann ein zusätzlicher Schlüssel erstellt werden.

​
API Key anlegen

Beim Erstellen eines neuen API Keys stehen folgende Optionen zur Verfügung:
  1. Name
    Frei wählbare Bezeichnung zur Identifikation des API Keys, z. B. Shopware Integration.
  2. Maximale Kosten pro Monat ($)
    • Begrenzung der monatlichen Kosten für diesen Key.
    • Wert 0 bedeutet, dass keine Kosten entstehen dürfen.
    • Wert -1 bedeutet kein Limit.
Hinweis Hochrechnung basierend auf Tokens und kann von den realen Abrechnungskosten abweichen.
  1. Assistenten des API Keys
    Auswahl, welche Assistenten über diesen Key nutzbar sind. Nur freigegebene Assistenten können von der angebundenen Anwendung angesprochen werden.

​
Typische Anwendungsfälle

  • Web-Chatbots mit Zugriff auf interne Wissensdatenbanken
  • Integration in CRM- oder ERP-Systeme zur automatisierten Verarbeitung von Kundenanfragen
  • Kundensupport-Portale, die Assistenten für FAQs oder Self-Service bereitstellen

​
Chat Completions API aufrufen

Assistenten können über den OpenAI-kompatiblen Endpunkt /api/v1/chat/completions angesprochen werden. Ersetzen Sie die Basis-URL durch die Adresse Ihrer VARIOS AI-Instanz (z. B. https://varios-ai.example.com). Authentifizierung: Im Header Authorization wird der API Key als Bearer-Token übergeben. Modell-Parameter: Der Wert für model entspricht der Assistenten-ID des Assistenten, den Sie ansprechen möchten. Nur Assistenten, die dem API Key zugewiesen sind, können genutzt werden. Optionale Parameter:
  • stream: true für Streaming-Antworten, false für eine vollständige Antwort in einer Antwort.
  • dlp_active: true aktiviert die Data-Loss-Prevention-Prüfung für die Anfrage, false deaktiviert sie.
curl -X POST 'https://example.com/api/v1/chat/completions' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "model": "ASSISTANT_ID",
    "stream": false,
    "dlp_active": false,
    "messages": [
      {
        "content": "Warum ist der Himmel blau?",
        "role": "user"
      }
    ]
  }'

​
Verwaltung

  • Bearbeiten: Anpassung von Name, Kostenlimit und zugewiesenen Assistenten.
  • Löschen: Entfernt den API Key dauerhaft (Zugriff wird sofort gesperrt).