Zum Hauptinhalt springen

Überblick

Die nuwacom API bietet programmatischen Zugriff auf deinen Workspace: KI-Completions mit führenden Modellen ausführen, Agents verwalten und mit deiner Wissensdatenbank arbeiten. Ob du eigene Anwendungen baust, Workflows automatisierst oder bestehende Systeme erweiterst, die API liefert die passenden Bausteine.

Verfügbare APIs

Completion API

Führe KI-Completions über eine OpenAI-kompatible Schnittstelle aus. Richte ein OpenAI-SDK auf einen Space; der Request läuft gegen einen serverseitigen Agenten mit Zugriff auf die Wissensdatenbank dieses Spaces. SDK-Quickstarts, die Tabelle der unterstützten Parameter und die knowledge-Erweiterung findest du in der Completion API Overview (auf Englisch).

Agents API

Erstelle und verwalte Agents programmatisch, mit eigenen Instruktionen, Gesprächseinstiegen und Modell-Optionen.

Assets API

Verwalte Dokumente in deiner Wissensdatenbank für Retrieval-Augmented Generation.

KI-Modelle

Finde heraus, welche Modelle in deinem Workspace und deinen Spaces verfügbar sind. Diese Modell-IDs verwendest du in Completion-Requests und Agent-Optionen.

Erste Schritte

Base URL

Jede nuwacom-Instanz läuft auf einer eigenen Tenant-Domain. Verwende den Tenant-Namen deines Workspace für alle API-Requests:

Authentifizierung

Alle API-Requests erfordern eine Authentifizierung per Bearer-Token:
Admins können API-Keys in den Workspace-Einstellungen im Bereich API Keys erstellen und verwalten. Wenn du kein Admin bist, wende dich an deinen nuwacom-Admin, um einen API-Key anzufordern.
Bewahre deinen API-Key in einer sicheren Backend-Umgebung auf. Verwende ihn niemals in clientseitigem Code, etwa in JavaScript im Browser.

Spaces

Die meisten Ressourcen (Agents, Assets, Unterhaltungen) gehören zu einem Space. Die entsprechenden Requests erwarten die Space-ID, entweder im URL-Pfad (z. B. /api/v1/spaces/{spaceId}/agents) oder als space_id-Parameter, und die Rolle des Aufrufers im Space bestimmt, was erlaubt ist.

OpenAPI-Spezifikation

Eine vollständige OpenAPI-Spezifikation für deine Instanz findest du unter https://{customer-tenant}.nuwacom.ai/api/openapi.json Wir bieten zwei benutzerfreundliche Oberflächen, um die OpenAPI-Dokumentation zu erkunden:
  • Scalar: https://{customer-tenant}.nuwacom.ai/api/scalar
  • Swagger UI: https://{customer-tenant}.nuwacom.ai/api/swagger

Completion API

Die grundlegende API ist die Completion API. Damit kannst du KI-Modelle in anderen Tools oder in deinen eigenen Workflows verwenden. Der space-bezogene Endpoint ist OpenAI Chat Completion; der bisherige Pfad bleibt unter Completion Endpoint.