API

Drittsysteme können per REST-API auf Daten aus skai zugreifen. So lassen sich bestehende Anwendungen mit der Wissensbasis, Chats oder Workflows Ihrer skai-Organisation verbinden.

Für die Authentifizierung wird ein API-Token benötigt.

API-Token verwalten

Die Verwaltung der Token erfolgt über den Menüpunkt API-Token in der Hauptnavigation. Er ist für alle Benutzer sichtbar, die in mindestens einem Space das Verwaltungsrecht API-Token verwalten besitzen. Administratoren besitzen dieses Recht nicht automatisch – es muss ihnen wie jedem anderen Mitglied im Space vergeben werden.

Klicken Sie auf Anlegen, um einen neuen Token zu erzeugen. Der Token wird aus Sicherheitsgründen nur einmal nach der Erstellung angezeigt – speichern Sie ihn sicher ab.

Jeder Token ist an genau einen Space gebunden. Er greift auf diesen Space und alle darunterliegenden Sub-Spaces zu, jedoch nie auf übergeordnete oder benachbarte Spaces. Einen Token verwalten dürfen Sie, wenn Sie im gebundenen Space (oder einem übergeordneten Space) das Recht API-Token verwalten besitzen.

Token-Optionen

Beim Anlegen eines Tokens legen Sie fest:

Space – Der Space, an den der Token gebunden wird. Die Bindung ist nach dem Anlegen unveränderlich.
Fähigkeiten – Legt fest, welche Aktionen der Token im gebundenen Space (und dessen Sub-Spaces) ausführen darf. Mindestens eine Fähigkeit ist erforderlich; sie sind nach dem Anlegen ebenfalls fest:
- Wissen lesen – Zugriff auf die Wissensinhalte des Spaces.
- Experten fragen – Erlaubt dem Token, Antworten über die Experten des Spaces anzufordern.
Gültig bis – Optionales Ablaufdatum. Nach diesem Datum wird der Token automatisch deaktiviert.
Tokenverbrauch beschränken – Setzt ein tägliches und/oder monatliches Credit-Limit. Bei Überschreitung werden weitere API-Aufrufe mit einem Fehler abgelehnt.

Beim Bearbeiten eines bestehenden Tokens lassen sich nur noch der Name und die Verbrauchsgrenzen ändern – nicht mehr der Space und die Fähigkeiten. Jeder Token zeigt unter dem Reiter Statistiken den bisherigen Verbrauch sowie – sofern konfiguriert – den Fortschritt gegen das monatliche Limit an.

Wichtige Hinweise

Sichtrechte: Ein API-Token besitzt nur die explizit zugewiesenen Berechtigungen. Vergeben Sie Token nur an vertrauenswürdige Systeme und vermeiden Sie die Weitergabe im Klartext.
Gültigkeit: Token können mit einem Ablaufdatum versehen werden. Nach Ablauf muss ein neuer Token generiert werden.
Widerruf: Ein Token kann jederzeit widerrufen werden. Widerrufene Token werden sofort ungültig.
Rate-Limits: Jeder Token zählt gegen die organisationsweiten Credits. Mit einem optionalen monatlichen Limit können Sie den Verbrauch einzelner Integrationen deckeln.

Verwendung

Alle API-Aufrufe erfolgen per HTTPS. Der Token wird im HTTP-Header als Bearer-Token mitgegeben:

Authorization: Bearer <api-token>

API-Referenz

Die vollständige API-Referenz wird direkt aus der OpenAPI-Spezifikation erzeugt.

Alle Spaces abrufen

/api/extern/v1/space

Gibt eine Liste von Spaces zurück, auf die mit dem angegebenen API-Schlüssel zugegriffen werden kann. Es werden maximal 100 Elemente zurückgegeben.

Request parameters

Responses

[
  {
    "id": "18ad0215-778d-352d-8f14-959901273e8d",
    "name": "example"
  }
]

Gesamtanzahl von Spaces abrufen

/api/extern/v1/space/count

Gibt die Gesamtanzahl der Spaces zurück, auf die mit dem angegebenen API-Schlüssel zugegriffen werden kann.

Request parameters

Responses

Quellen in einem Space abrufen

/api/extern/v1/space/{spaceId}/source

Gibt eine Liste von Quellen innerhalb eines bestimmten Spaces zurück. Es werden maximal 100 Elemente zurückgegeben.

Request parameters

Responses

[
  {
    "id": "18ad0215-778d-352d-8f14-959901273e8d",
    "spaceId": "18ad0215-778d-352d-8f14-959901273e8d",
    "name": "example"
  }
]

Gesamtanzahl von Quellen in einem Space abrufen

/api/extern/v1/space/{spaceId}/source/count

Gibt die Gesamtanzahl der Quellen innerhalb eines bestimmten Spaces zurück.

Request parameters

Responses

Dokumente in einer Quelle abrufen

/api/extern/v1/source/{sourceId}/source-document

Gibt eine Liste von Dokumenten innerhalb einer bestimmten Quelle zurück. Es werden maximal 100 Elemente zurückgegeben.

Request parameters

Responses

[
  {
    "id": "18ad0215-778d-352d-8f14-959901273e8d",
    "spaceId": "18ad0215-778d-352d-8f14-959901273e8d",
    "sourceId": "18ad0215-778d-352d-8f14-959901273e8d",
    "name": "example",
    "lastModified": "1971-04-26T12:26:06Z",
    "webUrl": "example"
  }
]

Gesamtanzahl von Dokumenten in einer Quelle abrufen

/api/extern/v1/source/{sourceId}/source-document/count

Gibt die Gesamtanzahl der Dokumente innerhalb einer bestimmten Quelle zurück.

Request parameters

Responses

Experten befragen

/api/extern/v1/expert/{expertId}/ask

Stellt dem angegebenen Experten eine Frage und gibt die KI-generierte Antwort zurück.

Jede Anfrage verbraucht Credits aus dem Token-Kontingent des API-Schlüssels. Sobald das Limit erschöpft ist, wird der Fehler ApiKeyLimitExceeded (HTTP 422) zurückgegeben.

Request parameters

{
  "prompt": "Wie lautet die Rückgabefrist für Produkte?"
}

Responses

{
  "response": "Die Rückgabefrist beträgt 14 Tage ab Erhalt der Ware."
}

{
  "error": "ApiKeyLimitExceeded",
  "message": "Das Token-Limit für diesen API-Schlüssel wurde überschritten."
}

Dokumentinhalt abrufen

/api/extern/v1/source-document/{sourceDocumentId}/content

Gibt den Textinhalt eines bestimmten Dokuments zurück.

Request parameters

Responses

03 September 2026