Zum Inhalt

Nuvoca REST-API

Mit der REST-API bindest du eigene Anwendungen an deinen Nuvoca-Workspace an. Du kannst Voice Agents, Agentic Flows, Tools, Knowledge Bases und Verarbeitungsprofile konfigurieren, vorhandene Rufnummern zuweisen und gespeicherte Anrufzusammenfassungen lesen.

Wenn du diese Aufgaben einem KI-Assistenten in natürlicher Sprache geben möchtest, beginne mit Nuvoca über MCP verbinden.

In drei Schritten starten

  1. Richte unter Einstellungen → API-Zugriff einen API-Schlüssel oder eine OAuth-Anwendung mit passenden Scopes ein.
  2. Prüfe den Workspace mit GET /api/external/v1/connection, wenn connection:verify freigegeben ist.
  3. Lies den benötigten Katalog und die aktuelle Konfiguration, bevor du Änderungen sendest. Die Beispiele zeigen den Ablauf.

Basisadresse und Authentifizierung

Die REST-API verwendet diese feste Basisadresse:

https://app.nuvoca.ai/api/external/v1

Jede Anfrage trägt Authorization: Bearer <ZUGANG>; der Zugang ist ein API-Schlüssel oder ein für die REST-API ausgestelltes OAuth-Access-Token. Der Workspace wird daraus bestimmt. Übergib keine Tenant-ID zur Auswahl eines anderen Workspaces.

Funktionen finden

Aufgabe Referenz
Schlüssel erstellen, OAuth einrichten und Rechte wählen Authentifizierung und Scopes
Endpunkte, Eingaben, Antworten und Fehler nachschlagen API-Referenz
Revisionen, Routing, Secrets und Zusammenfassungs-Auswahl verstehen Konfigurationsregeln
Agent erstellen, Prompt ändern, Dokument hochladen oder Tagesdaten lesen API-Beispiele
Dieselben Aufgaben über einen KI-Assistenten ausführen MCP-Toolreferenz

Änderungen zuverlässig verarbeiten

Lies eine Ressource vor dem Ändern und sende den vollständigen ETag einschließlich Anführungszeichen als If-Match. Bei 409 liest du erneut und gleichst die Änderung ab. Ein Timeout nach einer Erstellung beweist nicht, dass nichts gespeichert wurde: Prüfe vorhandene Ressourcen, bevor du erneut anlegst.

Agents, Tools und Profile werden durch API-Aufrufe direkt gespeichert. Rufnummernzuweisungen beeinflussen das Routing. Die Konfigurations-API startet keine Anrufe und führt keine Nachrichten-, Lookup- oder Webhooktests aus.

Speichere Zugangsdaten geschützt und verarbeite Prompts, Zusammenfassungen und Rufnummern nur in vorgesehenen Systemen. Die Regeln für Kundendaten gelten auch für deine Integration.