Zum Inhalt

Knowledge Bases und Dokumente

Verwende einen API-Schlüssel oder REST-OAuth-Access-Token. Scopes und deine aktuellen Workspace-Rechte gelten gemeinsam. Die Beispiele verwenden fiktive Daten.

Löschung einer Knowledge Base prüfen

GET /api/external/v1/knowledge-bases/{id}/deletion-checklist

Scope: knowledge-bases:write

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
ETag string Revision der Löschprüfung. Beim Löschen der Knowledge Base unverändert als If-Match senden.
Beispiel: "revision-from-get"

application/json

Feld Typ Beschreibung
assessmentToken string Token der Löschprüfung. Verwende für den Löschaufruf den ETag der Antwort.
canDelete boolean Ob die Knowledge Base derzeit gelöscht werden kann.
blockingReferences integer (int64) Zuordnungen oder Abhängigkeiten, die das Löschen verhindern. 
{
  "assessmentToken": "string",
  "canDelete": true,
  "blockingReferences": 0
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Knowledge Base erstellen

POST /api/external/v1/knowledge-bases

Scope: knowledge-bases:write

Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus.

Request-Body · application/json

Feld Typ Pflicht Beschreibung
title string Ja Anzeigename der Ressource.
Regeln: höchstens 255 Zeichen		 
{
  "title": "NuvoCar service"
}

Antwort 201

Erstellt.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
Location string Pfad der erstellten Ressource.
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
title string Anzeigename der Ressource.
version integer (int64) Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden. 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "title": "NuvoCar service",
  "version": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Knowledge Bases auflisten

GET /api/external/v1/knowledge-bases

Scope: knowledge-bases:read

Parameter

Name Position Typ Pflicht Beschreibung
page Query integer (int32) Nein Seitenindex ab 0.
Regeln: 0–100000
Standard: 0
size Query integer (int32) Nein Ergebnisse pro Seite.
Regeln: 1–100
Standard: 25

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store

application/json

Feld Typ Beschreibung
items Liste von object Ergebnisse dieser Seite.
page integer (int32) Aktueller Seitenindex, beginnend bei 0.
size integer (int32) Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements integer (int64) Gesamtzahl der passenden Ergebnisse.
totalPages integer (int32) Gesamtzahl der Ergebnisseiten.
items — Felder
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
title string Anzeigename der Ressource.
version integer (int64) Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden. 
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "title": "NuvoCar service",
      "version": 1
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Knowledge Base löschen

DELETE /api/external/v1/knowledge-bases/{id}

Scope: knowledge-bases:write

Verwende den ETag der frischen Löschprüfung statt der normalen Knowledge-Base-Version. Löse blockierende Zuordnungen zuerst.

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
If-Match Header string Ja ETag einer aktuellen Löschprüfung einschließlich Anführungszeichen.
Beispiel: "revision-from-get"

Antwort 204

Gelöscht; kein Response-Body.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Knowledge Base abrufen

GET /api/external/v1/knowledge-bases/{id}

Scope: knowledge-bases:read

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
title string Anzeigename der Ressource.
version integer (int64) Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden. 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "title": "NuvoCar service",
  "version": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Knowledge Base ändern

PUT /api/external/v1/knowledge-bases/{id}

Scope: knowledge-bases:write

Speichert die Konfiguration direkt; führt keinen Anruf, Tooltest oder Nachrichtenversand aus. Ressource zuerst lesen. Den aktuellen ETag einschließlich Anführungszeichen als If-Match senden. Vollständige bearbeitbare Konfiguration senden. Ausgelassene Einstellungen können zurückgesetzt werden.

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
If-Match Header string Ja ETag aus dem vorherigen Leseaufruf einschließlich Anführungszeichen.
Beispiel: "revision-from-get"

Request-Body · application/json

Feld Typ Pflicht Beschreibung
title string Ja Anzeigename der Ressource.
Regeln: höchstens 255 Zeichen		 
{
  "title": "NuvoCar service"
}

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
title string Anzeigename der Ressource.
version integer (int64) Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden. 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "title": "NuvoCar service",
  "version": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Wissensdokument löschen

DELETE /api/external/v1/knowledge-bases/{id}/documents/{documentId}

Scope: documents:write

Ressource zuerst lesen. Den aktuellen ETag einschließlich Anführungszeichen als If-Match senden.

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
documentId Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
If-Match Header string Ja ETag aus dem vorherigen Leseaufruf einschließlich Anführungszeichen.
Beispiel: "revision-from-get"

Antwort 204

Gelöscht; kein Response-Body.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Dokumentmetadaten lesen

GET /api/external/v1/knowledge-bases/{id}/documents/{documentId}

Scope: documents:read

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
documentId Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
title string Anzeigename der Ressource.
documentType string Typ des hochgeladenen Dokuments.
Werte: PDF, TEXT, XML, MARKDOWN, HTML, DOCX
version integer (int64) Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden. 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "title": "NuvoCar service",
  "documentType": "PDF",
  "version": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Dokumentmetadaten auflisten

GET /api/external/v1/knowledge-bases/{id}/documents

Scope: documents:read

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.
page Query integer (int32) Nein Seitenindex ab 0.
Regeln: 0–100000
Standard: 0
size Query integer (int32) Nein Ergebnisse pro Seite.
Regeln: 1–100
Standard: 25

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store

application/json

Feld Typ Beschreibung
items Liste von object Ergebnisse dieser Seite.
page integer (int32) Aktueller Seitenindex, beginnend bei 0.
size integer (int32) Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements integer (int64) Gesamtzahl der passenden Ergebnisse.
totalPages integer (int32) Gesamtzahl der Ergebnisseiten.
items — Felder
Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
title string Anzeigename der Ressource.
documentType string Typ des hochgeladenen Dokuments.
Werte: PDF, TEXT, XML, MARKDOWN, HTML, DOCX
version integer (int64) Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden. 
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "title": "NuvoCar service",
      "documentType": "PDF",
      "version": 1
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.

Wissensdokument hochladen

POST /api/external/v1/knowledge-bases/{id}/documents

Scope: documents:write

Lädt ein Dokument hoch und wartet auf dessen Verarbeitung. Liefert Dokumentmetadaten, nicht den Dateiinhalt.

Parameter

Name Position Typ Pflicht Beschreibung
id Pfad string (uuid) Ja Ressourcen-ID im gebundenen Workspace.

Request-Body · multipart/form-data

Feld Typ Pflicht Beschreibung
title string Ja Nicht leerer Dokumenttitel mit höchstens 255 Zeichen.
Regeln: 1–255 Zeichen
file string (binary) Ja Nicht leeres Wissensdokument. Zulässige Formate und Größenlimits stehen im Knowledge-Base-Leitfaden.

Antwort 201

Erstellt.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store
Location string Pfad der erstellten Ressource.
ETag string Aktuelle Revision. Bei erforderlichem If-Match unverändert einschließlich Anführungszeichen senden.
Beispiel: "revision-from-get"

application/json

Feld Typ Beschreibung
id string (uuid) Ressourcen-ID in deinem Workspace.
title string Anzeigename der Ressource.
documentType string Typ des hochgeladenen Dokuments.
Werte: PDF, TEXT, XML, MARKDOWN, HTML, DOCX
version integer (int64) Aktuelle Ressourcenversion. Beim Ändern oder Löschen den ETag der Antwort verwenden. 
{
  "id": "00000000-0000-0000-0000-000000000001",
  "title": "NuvoCar service",
  "documentType": "PDF",
  "version": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
404 Ressource im gebundenen Workspace nicht verfügbar.
409 Fehlende/veraltete Revision oder Abhängigkeits-/Routingkonflikt. Vor erneutem Versuch neu lesen.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.