API-Keys

​

API Keys

​

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

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.

3. DLP
   Legt fest, wie Data Loss Prevention (DLP) für alle Assistenten und Modelle dieses API Keys über die API angewendet wird:
   • Systemeinstellungen nutzen: DLP richtet sich nach der Einstellung des jeweiligen Assistenten bzw. Modells.
   • DLP erzwingen: DLP ist für alle Anfragen mit diesem Key aktiv, unabhängig von Assistenten-, Modell- oder Request-Einstellungen.
4. Assistenten
   Auswahl, welche Assistenten über diesen Key nutzbar sind. Nur freigegebene Assistenten können von der angebundenen Anwendung angesprochen werden. Auf den Assistenten-Karten sehen Sie die DLP-Einstellung des Assistenten (inklusive Modell-Kombination), nicht das durch DLP erzwingen am Key überschriebene Verhalten. Zusätzlich können Sie festlegen, ob Assistenten-Antworten kompatibel mit der Chat-Completions-API ausgegeben werden.
5. Modelle & Tools
   Auswahl, welche Chat-Modelle mit diesem Key verwendet werden dürfen. Nur Modelle, die die Chat Completions API unterstützen, sind mit der API kompatibel. Auf den Modell-Karten sehen Sie die DLP-Einstellung des Modells, nicht das durch DLP erzwingen am Key überschriebene Verhalten. Das tatsächliche DLP-Verhalten bei API-Anfragen ergibt sich aus der Key-Einstellung und der Entity-Einstellung (siehe Tabelle unten). Im Bereich Tools (Modell-API) wählen Sie Connectoren und Wissensdatenbanken für direkten Modellzugriff über die API. In den Tool-Optionen können Sie clientseitig definierte Tools sperren oder alle ausgewählten Anwendungs-Tools dem Modell standardmäßig bereitstellen.

​

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
• Integration in Automatisierungstools zur intelligenten Steuerung automatisierter Workflows, etwa mit der n8n-Node
• Integration in IDEs zur KI-gestützten Unterstützung bei der Entwicklung

​

Chat Completions API aufrufen

• Die Chat-Modell-ID ist der URL der jeweiligen Modell-Einstellungsseite zu entnehmen. (z. B. varios-ai.example.com/admin/models/**782d877e-b54f-4598-a32e-4a7d16e221e3**)
• Die Assistenten-ID ist der URL der jeweiligen Assistenten-Einstellungsseite zu entnehmen. (z. B. varios-ai.example.com/admin/assistants/**584ab525-7988-4e5d-8140-b03e4c9ee66c**)

• stream: true für Streaming-Antworten, false für eine vollständige Antwort in einer Antwort.
• stream_options: Mit {"include_usage": true} sendet ein Stream wie bei OpenAI zum Schluss einen Chunk mit leerem choices und dem Token-Verbrauch unter usage.
• dlp_active: Steuert DLP nur, wenn der API Key Systemeinstellungen nutzt und der Assistent bzw. das Modell DLP auf optional steht. true aktiviert DLP, false deaktiviert es. Fehlt der Parameter, ist DLP bei optional standardmäßig aktiv (wie im Chat).

​

DLP-Verhalten bei API-Anfragen

• Wissensdatenbank: kb_<wissensdatenbank-id>
• MCP-Tool: mcp_<mcp-tool-id>
• OpenAPI-Endpunkt: openapi_<openapi-endpunkt-id>
• Code-Connector (z. B. FLUX Konnektor): pf_<connector-id>

​

Beispiel: Assistent

​

Beispiel: Chat-Modell

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,
    "messages": [
      {
        "content": "Warum ist der Himmel blau?",
        "role": "user"
      }
    ]
  }'

curl -X POST 'https://example.com/api/v1/chat/completions' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "model": "CHAT_MODELL_ID",
    "stream": false,
    "dlp_active": false,
    "messages": [
      {
        "content": "Warum ist der Himmel blau?",
        "role": "user"
      }
    ],
    "response_format": "your-response-format",
    "tools": [
      {"type": "function", "function": {"name": "mcp_<mcp-tool-id>"}},
      {"type": "function", "function": {"name": "openapi_<openapi-endpunkt-id>"}},
      {"type": "function", "function": {"name": "pf_<connector-id>"}},
      {"type": "function", "function": {"name": "kb_<kb-id>"}},
      {
        "type": "function",
        "function": {
          "name": "eigenes_tool",
          "description": "Beispiel für ein clientseitig definiertes Tool",
          "parameters": {
            "type": "object",
            "properties": {"query": {"type": "string"}},
            "required": ["query"]
          }
        }
      }
    ]
  }'

​

Verfügbare Assistenten und Modelle abfragen

curl 'https://example.com/api/v1/models?includeType=1&includeDlp=1' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​

Verwaltung

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