Bauen Sie auf iNTELIGENCIA VIVA auf
Die öffentliche API ist der Erweiterungspunkt für alles, was ein Entwickler auf einem Workspace aufbauen möchte: Gespräche in ein eigenes System weiterleiten, einem KI-Agenten ein Tool geben, das das ERP eines Kunden abfragt, Kontakte mit einem CRM synchronisieren oder Live-Ereignisse in ein eigenes Dashboard streamen. Sie ist REST, versioniert als v1, und jede Ressource im Datenmodell des Produkts ist über sie erreichbar.
Authentifizierung
Jede Anfrage wird mit einem API-Schlüssel authentifiziert, der im Workspace-Panel ausgestellt und als `Authorization: Bearer sk_live_...` gesendet wird.
Jeder Schlüssel trägt seinen eigenen konfigurierbaren Berechtigungsumfang — ein Schlüssel kann auf Nur-Lese-Zugriff, auf bestimmte Ressourcen beschränkt oder mit vollem Lese-Schreib-Zugriff versehen werden, unabhängig von jedem anderen Schlüssel, der für denselben Workspace ausgestellt wurde.
Schlüssel werden nur einmal, im Moment ihrer Erstellung, vollständig angezeigt; danach kann nur noch ihr Inhaber sie wieder einsehen, und jeder Schlüssel kann jederzeit im Panel widerrufen werden, ohne andere Schlüssel zu beeinträchtigen.
Authorization: Bearer sk_live_...
Ressourcen
Jede Ressource im zugrunde liegenden Datenmodell ist über die API verfügbar:
| Workspace | Allgemeine Konfiguration, Standardsprache, aktivierte Kanäle. |
| Contact | Erstellen, Suchen und Nachschlagen der Endkunden, die schreiben. |
| Conversation | Gespräche auflisten, erstellen, schließen und neu zuweisen. |
| Message | Nachrichten innerhalb eines Gesprächs senden und lesen. |
| Department | Teams und ihre Routing-Regeln verwalten. |
| Agent | Menschliche Nutzer, Rollen und Abteilungszugehörigkeit verwalten. |
| AIAgent | KI-Agenten erstellen und konfigurieren: Anweisungen, Wissensbasis, aufrufbare Tools. |
| KnowledgeSource | Dokumente und URLs für RAG hochladen und verwalten. |
| Channel | Kanäle und ihre Zugangsdaten konfigurieren. |
| Webhook | Ausgehende Ereignisse abonnieren, signiert mit HMAC. |
| APIKey | Schlüssel ausstellen und widerrufen. |
Webhook-Ereignisse
Abonnieren Sie einen `WebhookEndpoint` für jedes dieser Ereignisse; jede Zustellung wird mit HMAC signiert, unter Verwendung des mit diesem Endpunkt verknüpften Secrets, sodass Sie überprüfen können, dass sie von uns stammt, bevor Sie ihrem Inhalt vertrauen:
| conversation.created | Ein neues Gespräch wurde auf einem beliebigen Kanal gestartet. |
| conversation.assigned | Ein Gespräch wurde einem menschlichen Agenten oder einer Abteilung zugewiesen. |
| conversation.resolved | Ein Gespräch wurde geschlossen, von der KI oder von einem Menschen. |
| message.received | Eine neue eingehende Nachricht ist von einem Kontakt eingetroffen. |
| message.sent | Eine Nachricht wurde an einen Kontakt gesendet, von der KI oder von einem Agenten. |
| handoff.requested | Die Konfidenz der KI ist unter die Schwelle des Workspace gefallen, und sie hat einen Menschen angefordert. |
| ai_agent.tool_call | Ein KI-Agent hat eines seiner konfigurierten Tools aufgerufen, einschließlich Tools, die Sie selbst registriert haben. |
Zustellungen werden bei einem Fehler wiederholt und sind nicht garantiert genau einmal — gestalten Sie Ihren Webhook-Handler idempotent. Die vollständige Semantik von Zustellung und Wiederholung ist in den API-Nutzungsbedingungen für Entwickler dokumentiert.
Echtzeit-Streaming
Für Integrationen, die Ereignisse live konsumieren müssen, statt oder zusätzlich zu Webhooks, stellt jeder Workspace einen WebSocket-Streaming-Endpunkt bereit:
wss://api.inteligenciaviva.com/v1/workspaces/{id}/stream
Ratenlimits und faire Nutzung
Der API-Zugriff unterliegt Ratenlimits, die an den Plan Ihres Workspace gebunden sind; eine Anfrage über dem Limit wird mit HTTP 429 und den aktuellen Ratenlimit-Headern signalisiert, sodass Sie ein korrektes Backoff implementieren können. Die genauen Limits und die vollständig verbindlichen Nutzungsbedingungen der API — einschließlich dessen, was Sie mit den über die API abgerufenen Daten tun dürfen und was nicht — sind in den API-Nutzungsbedingungen für Entwickler festgelegt, verlinkt von der Seite Rechtliches.