Zum Inhalt springen

Service API + MCP

Die Service API (service.testing.nairon.cloud) ist die REST-Steuerungsebene von Nairon, mit der Sie Ihr Konto programmatisch verwalten: Organisation und Projekte lesen, den Agenten eines einfachen Projekts (Vorlage, Begrüßung, Fähigkeiten) oder die Gespräche eines erweiterten Projekts und deren Gestaltung verwalten sowie Wissensdatenbanken, Integrationen, Telefonnummern, Web-Sitzungen und API-Schlüssel anlegen, lesen, ändern und löschen. Ein MCP-Server unter /mcp stellt dieselben Vorgänge als Werkzeuge für jeden MCP-fähigen Client bereit.

Jede Anfrage wird mit einem geheimen API-Schlüssel (nrn_sk_...) authentifiziert, gesendet als Authorization: Bearer nrn_sk_... oder x-api-key: nrn_sk_.... Öffentliche Schlüssel (publishable, wie sie browserseitige Oberflächen wie das Web-Widget verwenden) werden auf jeder Route abgelehnt.

Einen geheimen Schlüssel erzeugen Sie auf der Seite API-Schlüssel Ihres Projekts: in der Anwendung unter ui.testing.nairon.cloud (Einrichtung → API-Schlüssel) für ein normales Hotline- oder Anwendungsprojekt oder in der Plattformkonsole unter platform.testing.nairon.cloud für ein Plattformprojekt. Einzelheiten unter API-Schlüssel. Mit der nächsten Version des Dienstes liefert GET /v1/me Organisations-ID, Projekt-ID, Geltungsbereich und Namen des aufrufenden Schlüssels (nie den Schlüssel selbst) – siehe Me.

  • Ressourcen – Organization, Project, Agent eines einfachen Projekts (mit Katalog der Fähigkeiten und Vorlagen), Conversation, Knowledge, Integrations, Numbers, Web Sessions und Keys: was jede Ressource liefert und welche Lese- und Schreibvorgänge es dafür gibt.
  • Gesprächsgestaltung – das portable, von der Umsetzung unabhängige Dokumentformat, in dem die Gestaltung eines Gesprächs gelesen und geschrieben wird.
  • MCP – einen MCP-Client mit /mcp verbinden und die vollständige Liste der Werkzeuge.
  • Fehler – die Antwortstruktur, die jeder Fehler verwendet, und die vollständige Referenz der Fehlercodes.

Das vollständige, automatisch erzeugte Anfrage- und Antwortschema jeder Route finden Sie in der vollständigen Endpunkt-Referenz.