In drei Schritten live.
API Key holen, ersten Request schicken, Webhook empfangen — alles in unter einer Stunde.
ssc_k9m2p••••••••••••••••••••KopierenAPI Key erstellen
Im Dashboard unter Einstellungen → API Keys. Der Schlüssel wird einmalig angezeigt — sicher speichern.
Erste Nachricht senden
POST an den Conversations-Endpoint mit Ihrer sessionId. Antwort kommt direkt aus Ihrer Wissensbasis.
Webhook empfangen
HTTPS-Endpoint registrieren, Signatur prüfen, Events verarbeiten. Jedes Event enthält eine HMAC-SHA256-Signatur zur Verifikation.
Alle Endpoints im Überblick.
Basis-URL: api.orain.ai/v1 · Bearer Auth · 1.000 Req/Std · Einheitliche JSON-Antwortstruktur
Skaliert mit Ihrer Wissensbasis.
Von einzelnen Dokumenten bis zu unternehmensweiten Wissensdatenbanken — mit dediziertem Vektor-Index pro Tarif.
Ein Webhook für jedes Event. Signiert. In Echtzeit.
Jedes Event wird HMAC-SHA256-signiert an Ihren HTTPS-Endpoint gesendet — mit Delivery-ID für Idempotenz und Timestamp-Validierung gegen Replay-Angriffe.
conversation.startedErste Nachricht einer neuen Sessionmessage.receivedJede Folgenachricht des Nutzersmessage.sentChatbot sendet Antwort (inkl. responseTimeMs)knowledge.addedDokument oder URL als Wissensquelle hinzugefügtknowledge.deletedWissensquelle gelöschthuman.handoff.requestedNutzer bittet um Mensch oder KI erkennt Bedarfenthält conversationContext (letzte 5 Nachrichten)lead.generatedErster Lead in einer Sitzung erkanntlead.updatedBestehender Lead in gleicher Sitzung aktualisiertsupport.ticket.generatedErstes Ticket in einer Sitzung erkanntsupport.ticket.updatedBestehendes Ticket in gleicher Sitzung aktualisiertX-Webhook-Signaturesha256={hmac}X-Webhook-Timestamp{unix-timestamp}X-Webhook-Delivery-Iddel_{uuid}User-AgentSolidScale-Webhook/1.0Chatbot ruft Ihre API. Live im Gespräch.
Definieren Sie eigene HTTP-Funktionen direkt im Dashboard — der Chatbot erkennt den richtigen Moment im Gespräch, extrahiert Parameter aus der Konversation und ruft Ihren Endpoint auf. Das API-Ergebnis fließt direkt in die nächste Antwort ein.
- ✓Beliebige REST-Endpoints — GET oder POST
- ✓Parameter werden vom Chatbot aus dem Chat extrahiert
- ✓Header mit Secret-Option für API-Keys und Tokens
- ✓Antwortfelder filterbar — nur relevante Daten an die KI
- ✓Timeout konfigurierbar (Standard: 10 Sekunden)
- ✓Mehrere Funktionen pro Agent kombinierbar
Funktionen per API anlegen & verwalten.
Neben dem Dashboard können benutzerdefinierte Funktionen vollständig über die REST API gesteuert werden — anlegen, aktualisieren, löschen. Ideal für automatisiertes Provisioning oder Multi-Tenant-Setups.
paramsParameterliste — werden vom Chatbot aus dem Chat extrahiertheaders.secretSecret-Flag: Wert wird verschlüsselt gespeichert & nie zurückgegebenresponse_fieldsFilterung der API-Antwort — nur relevante Felder an die KItimeoutMax. Wartezeit in Sekunden (Standard: 10)