Auf dieser Seite erfahren Sie was ein API-Key ist, wie Sie diesen für RWTHgpt erstellen und für den Zugriff auf die verfügbaren KI:connect-Modelle über die API (Application Programming Interface) einsetzen.

Ein API-Key ist ein geheimer Zugriffsschlüssel, der es Anwendungen ermöglicht, sicher auf einen Chatbot-Dienst zuzugreifen. Er dient der Identifikation und Authentifizierung von Anfragen, regelt Berechtigungen und ermöglicht die Kontrolle sowie Zuordnung der Nutzung. API-Keys werden verwendet, um Chatbots in eigene Anwendungen, Websites oder interne Systeme zu integrieren und müssen vertraulich behandelt werden.

Die KI:connect-API ist OpenAI-kompatibel. Dadurch kann beispielsweise das OpenAI-SDK mit angepasster Base-URL verwendet werden. Die API ist unter der Base-URL https://chat.kiconnect.nrw/api/v1 erreichbar. Die Authentifizierung erfolgt über einen Bearer Token, wobei der API-Key im HTTP-Header (Authorization: Bearer <API-Key>) übergeben wird.

Um einen API-Key zu generieren, folgen Sie bitte nachfolgenden Schritten:

Schritt 1
Melden Sie sich in der KI:connect-Weboberfläche via RWTH Single Sign-On an.

Schritt 2
Klicken Sie am unteren linken Rand auf Ihren Namen (1) und wählen Sie API-Schlüsselverwaltung (2) aus.

Schritt 3
Klicken Sie nun auf Schlüssel erstellen (3)
Es wird ein personalisierter API-Key erstellt.
Den Namen können Sie falls gewünscht selbst unter Schlüsselname (4) vergeben. 

Nutzende, die Mitglied mehrerer Nutzendengruppen sind, können für den API-Schlüssel festlegen, auf welche Nutzendengruppe die Nutzung der KI-Modelle angerechnet wird.

Virtuelle API-Schlüssel besitzen eine Laufzeit von einem Monat. Nach Ablauf müssen sie über die Funktion „Rotieren“ erneuert werden. Dabei wird ein neuer Schlüssel erzeugt. Abgelaufene Schlüssel können nicht weiter verwendet werden.

Über das Informationssymbol (5) gelangen Sie zur externen KI:connect API-Dokumentation. Dort finden Sie Informationen zu den verfügbaren API-Endpunkten (z. B. chat/completions, responses, embeddings und models) sowie zu den aktuell unterstützten Modellen.

+