SDK und API-Dokumentation
Eine API für den ganzen neuland.ai HUB.
Mit SDKs für Python und Node.
Chat, Dokumentenabfragen, Agenten, Integrationen und die Verwaltung dahinter: alles über eine REST-API mit OpenAPI-Spezifikation, dazu typisierte Clients für Ihre eigenen Anwendungen.
Was die API abdeckt
Was Sie über die API steuern.
Die ganze Plattform, nicht nur den Chat.
Die Endpunkte sind nach Ressourcen gruppiert und in einer OpenAPI-Spezifikation beschrieben. Die Referenz zeigt zu jedem Endpunkt Parameter und Schemas und lässt ihn direkt ausprobieren.
Chat und Agenten
Chats und Nachrichten samt Antworten, Bewertungen, Agenten (in der API: Assistenten) mit ihrem Verhalten, wiederverwendbare Prompts und Templates.
Dokumente und Wissensabfragen
Dokumente hochladen, indexieren und in Bibliotheken ordnen, Abfragen mit Retrieval über den Bestand stellen, Audio transkribieren.
Tools und Aktionen
Tools, die Agenten aufrufen, und die Ausführung einzelner Aktionen, etwa den Versand einer E-Mail.
Datenquellen
Datenquellen wie SharePoint, OneDrive, Nextcloud, Confluence oder Jira durchsuchen und anbinden; OAuth-Verbindungen zu externen Diensten je Person.
Nutzer, Mandanten und Projekte
Konten und Profile, Einladungen, Mandanten mit Branding und Mitgliedschaften, Projekte, die Chats und Dokumente bündeln.
Modelle und Verbrauch
Modellkatalog, Modelleinstellungen je Mandant, Token-Verbrauch und Kosten, Budgetwarnungen und Tarife.
REST-API und SDKs
Direkt per HTTP oder mit SDK.
Die Endpunkte bleiben dieselben.
Die Abbildung zeigt einen Beispielaufruf mit dem Node-SDK.
Die REST-API rufen Sie aus jeder Sprache auf. Wer lieber mit Typen arbeitet, nimmt die generierten SDKs: Jede Ressource wird zu einer Client-Klasse, jeder Endpunkt zu einer Methode.
REST-API
HTTP-Endpunkte mit JSON, beschrieben in einer OpenAPI-Spezifikation, aufrufbar aus jeder Sprache.
Python-SDK
Typisierte Anfragen und Antworten für Python ab Version 3.13.
Node-SDK
Derselbe Client für Node.js ab Version 18, mit TypeScript-Typen.
Immer passend zur Version
Die Methodenreferenz der SDKs entsteht mit jedem Release direkt aus dem Paket.
Authentifizierung
So melden sich Ihre Anwendungen an.
Mit API-Schlüssel, Token oder Service-Token.
Den Zugang steuern Ihre Admins. Schlüssel entstehen im neuland.ai HUB oder per API und lassen sich jederzeit widerrufen.
API-Schlüssel
Header X-API-KEY
Ihre Anwendung schickt den Schlüssel bei jeder Anfrage mit. Admins legen ihn in den Einstellungen unter API Keys an oder per API.
Lebenszyklus
Widerrufbar
Der vollständige Schlüssel erscheint nur einmal bei der Erstellung. Zum Rotieren oder Sperren wird er widerrufen und neu angelegt; ein Ablaufdatum ist möglich.
Anmeldung
Token und SSO
Neben Schlüsseln: Anmeldung über die Auth-Endpunkte mit Bearer-Token, SSO und OAuth-Verbindungen zu externen Diensten.
Apps im neuland.ai HUB
Service-Token
KI-Anwendungen, die im neuland.ai HUB laufen, brauchen keinen eigenen Schlüssel: Der neuland.ai HUB übergibt beim Start ein signiertes Token (JWT).
Fragen
Fragen zu Zugang, SDKs und Authentifizierung.
Etwas an den neuland.ai HUB anbinden?
Wir besprechen es mit Ihnen.
Sagen Sie uns kurz, was Sie anbinden oder darauf bauen möchten.
Nach Ihrer Anfrage
01
Sie beschreiben kurz Ihr Vorhaben
02
Wir zeigen Ihnen die passenden Endpunkte und SDK-Methoden
03
Ihre Admins legen den API-Schlüssel im neuland.ai HUB an