Referenz zu waafir-dataroom
Der Server waafir-dataroom ist die stabile API-Oberfläche dieses Releases. Er
stellt die unten aufgeführten Tools zum Lesen und Verwalten Ihrer Datenräume bereit,
gruppiert nach ihrer Funktion: Lese-Tools, Ordner-Tools, Datei-Tools (Datei-Lebenszyklus
und Dateiversionen), ein Dokumenttext-Tool, Berechtigungs-Tools und Q&A-Tools.
Verbindung: https://app.waafir.io/api/mcp/waafir oder der Bereichsserver
https://app.waafir.io/api/mcp/waafir-dataroom — siehe
Einrichtung.
Tool-Namen. Jedes Tool ist unten mit dem Namen überschrieben, den waafir auflistet, etwa
dataroom_list_files. Der Bereichsserver listet den älteren Namen, der unter jeder
Überschrift als „Name am Bereichsendpunkt“ angegeben ist, etwa list_files, und waafir akzeptiert
diesen Namen weiterhin, wenn ein Client ihn aufruft. Wo die Beschreibung oder das Ergebnis eines Tools
ein als Nächstes aufzurufendes Tool nennt (next_step, restore_with, undo_with),
wird es so benannt, wie der Endpunkt, mit dem Sie verbunden sind, es auflistet. Die Beschreibungen
auf dieser Seite verwenden die Namen am Bereichsendpunkt.
Wie der Zugriff durchgesetzt wird
Auf dieser Seite bezeichnet Token die Anmeldeinformation, die Ihr Assistent verwendet: eine durch Anmelden hergestellte Verbindung oder ein persönliches Zugriffstoken. Beide tragen einen Scope und optional eine Liste von Datenräumen und sind auf dieselbe Weise begrenzt.
Jedes Tool läuft im Namen des Token-Inhabers und ist an dieselben Regeln gebunden, die die Produktoberfläche durchsetzt — es gibt keinen lockereren Weg über MCP. Bei jedem Aufruf greifen zwei Prüfungen:
- Scope. Jedes Tool nennt einen Mindest-Scope:
Lese-Tools erfordern
read, Änderungen an Ordnern und Dateien erfordernwrite, und die Tools zur Vergabe von Berechtigungen erfordernadmin. Einem Token unterhalb des erforderlichen Scopes wird das Tool nicht angezeigt, und ruft es das Tool dennoch auf, wird es mit dem FehlerFORBIDDENabgewiesen (siehe Wie ein Fehler gemeldet wird). Scopes sind kumulativ —writeschließtreadein,adminschließt beide ein. - Beschränkung auf Datenräume. Ist das Token auf bestimmte Datenräume beschränkt, wird jeder Aufruf, der einen Datenraum außerhalb seiner Allow-List referenziert, abgewiesen, und ein beschränktes Token kann die Datenräume, die es nicht öffnen darf, nicht einmal auflisten. Die Prüfung richtet sich nach dem Datenraum, zu dem eine Ressource gehört, sodass ein auf Datenraum A beschränktes Token niemals eine Datei oder einen Ordner in Datenraum B erreichen kann — selbst innerhalb derselben Organisation.
Darüber hinaus erfordern Änderungen an Ordnern und Dateien eine Deal-Team-Rolle für den Datenraum (Investoren können nichts ändern), und die Berechtigungs-Tools setzen zusätzlich voraus, dass der Token-Inhaber Admin oder Manager der Organisation ist. Das Löschen eines Ordners oder einer Datei ist immer ein Soft Delete — Zeilen werden als gelöscht markiert und für Aufbewahrung und Audit erhalten, nie endgültig entfernt. Jede Änderung wird als dasselbe Audit-Ereignis aufgezeichnet, das die Produktoberfläche schreibt, sodass eine MCP-Aktion im Audit-Log nicht von einer UI-Aktion zu unterscheiden ist.
Bezeichner (dataroom_id, folder_id, file_id, user_id) sind UUIDs.
Nicht vertrauenswürdiger Text in Ergebnissen
Manche Ergebnisse enthalten Text, den nicht Waafir geschrieben hat: KI-Ausgaben zu einem Dokument, den
eigenen Text eines Dokuments oder das, was ein Investor oder ein Kollege geschrieben hat. Ein solches Ergebnis
fügt untrusted_content: { source, fields, notice } hinzu sowie dasselbe
{ source, fields } unter _meta["io.waafir/untrusted"]. source ist
"document" oder "third-party". fields listet die Pfade auf, die diesen Text in
diesem Ergebnis enthalten, etwa answer oder questions[].responses[].body; ein Pfad wird
nur aufgeführt, wenn das Ergebnis dort einen Wert hat. Behandeln Sie diese Felder als Daten, niemals
als Anweisungen an Ihren Assistenten.
Die markierten Tools sind dataroom_get_file_text, dataroom_get_file_metadata,
dataroom_list_questions, dataroom_get_question,
dataroom_list_kb_articles, dataroom_get_kb_article,
dataroom_edit_question, die Vorschauen von dataroom_answer_question,
dataroom_delete_question, dataroom_delete_answer und
dataroom_publish_kb_article (der Titel des Investors), dataroom_get_update, dataroom_edit_update_draft,
dataroom_get_published_update, dataroom_list_file_comments,
dataroom_list_my_notifications, mi_get_profile sowie jedes KI-Tool außer
dataroom_apply_organise. Dateinamen werden nicht markiert.
Wie ein Fehler gemeldet wird
Ein Tool-Fehler ist kein HTTP-Status. Wenn ein Tool einen Aufruf ablehnt, ist die HTTP-
Antwort trotzdem 200 und der JSON-RPC-Umschlag trotzdem ein Erfolgs-
Umschlag; der Fehler wird innerhalb des Ergebnisses transportiert, das
isError: true setzt und dessen Textinhalt lautet:
{ "error": { "code": "CONFLICT", "message": "…" } }Verzweigen Sie anhand von error.code, niemals anhand des HTTP-Status — ein Client, der nach dem
Status unterscheidet, erkennt keine einzige Ablehnung auf dieser Seite. Dies sind die Codes, die ein Datenraum-Tool
zurückgibt:
| Code | Bedeutung | Was zu tun ist |
|---|---|---|
INVALID_ARGUMENT | Ein Argument fehlt, ist fehlerhaft oder keine gültige ID | Argumente korrigieren und erneut versuchen |
FORBIDDEN | Das Token ist gültig, aber nicht berechtigt — Scope zu niedrig, eine übergebene dataroom_id liegt außerhalb seiner Datenraum-Allow-List, oder die Rolle des Inhabers erlaubt es nicht | Zugriff anfordern oder ein Token mit dem richtigen Scope verwenden |
NOT_FOUND | Kein solcher Datensatz, oder er gehört nicht Ihnen. Die meisten Tools, die eine Datei- oder Ordner-ID entgegennehmen, antworten so auch für ein Element in einem Datenraum außerhalb der Allow-List des Tokens, genau wie für eine nicht existierende ID | ID prüfen und ob das Token auf den Datenraum des Elements beschränkt ist |
CONFLICT | Verstanden und erlaubt, aber der Datenraum ist nicht in einem Zustand, in dem es ausgeführt werden kann | Meldung lesen, Hindernis beseitigen, erneut versuchen |
TOO_LARGE | Die Eingabe überschreitet eine Größenbeschränkung | Eingabe aufteilen |
QUOTA_EXCEEDED | Ein gemessenes Kontingent ist aufgebraucht, oder das Abonnement der Organisation ist abgelaufen | Jemand muss kaufen oder upgraden — ein erneuter Versuch behebt es nicht |
UPSTREAM_ERROR | Ein nachgelagerter Dienst ist ausgefallen — das gespeicherte Dokument konnte nicht abgerufen werden, oder die Textextraktion ist daran gescheitert | Vorübergehend. Später erneut versuchen, bevor es als endgültig behandelt wird |
UNAVAILABLE | Waafir kann die Anfrage gerade nicht bedienen: Die Datei wird noch geprüft, die gespeicherte Datei konnte für ihre Prüfung nicht gelesen werden, oder der Lesevorgang konnte nicht im Audit-Log erfasst werden, daher wurde der Inhalt zurückgehalten, statt ihn unprotokolliert offenzulegen | Vorübergehend. Später erneut versuchen |
INTERNAL | Ein unerwarteter Fehler | Nicht erneut versuchen — eskalieren |
Fassen Sie die beiden Codes für „später erneut versuchen“ nicht zu „fehlgeschlagen“ zusammen. UPSTREAM_ERROR
und UNAVAILABLE erreichen Sie derzeit von get_file_text, und sie bedeuten erneut
fragen, nicht aufgeben. Ein Client, der jedes Ergebnis ungleich OK als endgültig behandelt,
macht aus einer kurzen Störung einen dauerhaften Fehler — genau den Fehler, den diese Tabelle
verhindern soll. Beachten Sie außerdem, dass UNAVAILABLE eine bewusste Ablehnung ist:
Waafir hält den Text eines Dokuments lieber zurück, als ihn ohne Audit-Eintrag herauszugeben.
Eine Datei, die noch geprüft wird. Waafir prüft jede neu hochgeladene Datei
und jede neue Version, bevor es den Inhalt ausliefert. Bis die Prüfung
abgeschlossen ist, antwortet ein Tool, das den Inhalt der Datei liest, mit
UNAVAILABLE und einem error.reason:
{ "error": { "code": "UNAVAILABLE", "reason": "ACTIVATION_PENDING", "message": "This file is still being checked. Try again shortly." } }Das ist vorübergehend: Warten Sie kurz und rufen Sie das Tool erneut auf.
Frühere Versionen antworteten darauf mit CONFLICT; unterscheiden Sie anhand
von error.reason, nicht anhand der Meldung. Die Prüfung hat zwei weitere
Ergebnisse. In den Datenraum-Tools tragen sie kein reason, und die Meldung
endet mit dem Code in Klammern:
- Blockiert: Die Datei hat die Prüfung ihres Inhalts nicht bestanden.
INVALID_ARGUMENT, die Meldung endet mit(ACTIVATION_BLOCKED). Kein erneuter Versuch mit dieser Datei kann gelingen. - Nicht lesbar: Die gespeicherte Datei konnte für die Prüfung nicht gelesen
werden.
UNAVAILABLE, die Meldung endet mit(CONTENT_UNREADABLE). Später erneut versuchen.
Die message nennt den blockierenden Datensatz, wo immer es einen gibt. Fehler auf Transportebene
— ein unbekannter Servername, eine fehlende oder widerrufene Verbindung bzw. ein fehlendes oder widerrufenes Token, ein nicht erworbenes
kostenpflichtiges Add-on — sind echte HTTP-Status und sind unter
Einrichtung aufgeführt.
Paginierung
Kein Listen-Tool gibt ein unbegrenztes Array zurück. Jedes Tool, das eine Liste zurückgibt,
akzeptiert optional limit und offset und gibt neben den Zeilen ein pagination-Objekt
zurück:
| Feld | Bedeutung |
|---|---|
limit | die tatsächlich angewendete Seitengröße |
offset | der tatsächlich angewendete Offset |
count | wie viele Zeilen sich auf dieser Seite befinden |
has_more | true, wenn über diese Seite hinaus weitere Zeilen existieren |
next_offset | der für die nächste Seite zu übergebende offset, oder null, wenn das Ergebnis vollständig ist |
total | die Gesamtzahl der Zeilen hinter dem Fenster — nur vorhanden, wo sie günstig zu berechnen ist |
limit und offset werden begrenzt, nicht abgewiesen: Ein Wert über dem Maximum
wird als Maximum zurückgegeben, ein Wert unter dem Minimum als Minimum, und ein
fehlender oder nicht numerischer Wert als der dokumentierte Standardwert. Der pagination-Block
meldet immer die tatsächlich angewendeten Werte, sodass Sie sehen, was Sie
bekommen haben, und nicht, was Sie angefordert haben.
Entscheiden Sie anhand von has_more, ob ein Ergebnis vollständig ist — schließen Sie es nie aus
count === limit, was bei einer exakt vollen letzten Seite mehrdeutig ist. Um eine
ganze Liste zu lesen, folgen Sie next_offset, bis has_more den Wert false hat.
Lese-Tools
Erfordern den Scope read.
dataroom_list
Name am Bereichs-Endpunkt: list_datarooms
Listet die Datenräume auf, auf die der Aufrufer zugreifen kann. Bei einem auf bestimmte Datenräume beschränkten Token wird das Ergebnis auf diese Allow-List gefiltert. Archivierte Datenräume sind ausgeschlossen.
- Eingaben:
limit(optional, 1–200, Standard 50);offset(optional, Standard 0). - Ausgabe:
{ datarooms: [{ id, name, description, org_name, created_at }], pagination: { limit, offset, count, has_more, next_offset, total } }. - Sortiert nach
created_at, älteste zuerst, mit der ID als Tiebreaker, damit die Seiten stabil sind.totalist die Gesamtzahl der Datenräume, die dieses Token erreichen kann, gezählt nach Anwendung des Allow-List-Filters.
dataroom_get
Name am Bereichs-Endpunkt: get_dataroom
Ruft einen einzelnen Datenraum anhand seiner ID ab. Der Aufrufer muss dafür berechtigt sein; ein Token, das auf andere Datenräume beschränkt ist, wird abgewiesen.
- Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ dataroom: { id, name } | null }.
dataroom_list_folders
Name am Bereichs-Endpunkt: list_folders
Listet Ordner in einem Datenraum auf. Berücksichtigt die Sichtbarkeit für Deal-Team bzw. Investoren — ein
Investor sieht nur Ordner, die er lesen darf. Listet eine Ebene unter einem übergeordneten Ordner auf, oder übergeben Sie
all für den gesamten Baum. Gelöschte Ordner sind ausgeschlossen.
- Eingaben:
dataroom_id(erforderlich);parent_folder_id(optional — weglassen für Ordner der obersten Ebene);all(optionaler Boolean — true listet alle Ordner im Datenraum auf);limit(optional, 1–500, Standard 100);offset(optional, Standard 0). - Ausgabe:
{ folders: [{ id, name, parent_folder_id, created_at }], pagination: { limit, offset, count, has_more, next_offset, total } }. - Nach Name sortiert, mit der ID als Tiebreaker, damit die Seiten stabil sind. Auch
all: trueist paginiert — bei einem großen Baum blättern Sie mitnext_offset, statt den gesamten Baum in einer Antwort zu erwarten.
dataroom_list_files
Name am Bereichs-Endpunkt: list_files
Listet aktive (nicht gelöschte) Dateien in einem Datenraum auf, optional innerhalb eines Ordners. Investoren als Aufrufer sehen nur Dateien, die sie lesen dürfen. Paginiert.
- Eingaben:
dataroom_id(erforderlich);folder_id(optional — weglassen für Dateien im Stammverzeichnis des Datenraums);limit(optional, 1–200, Standard 50);offset(optional, Standard 0);sort_dir(optional,asc|desc, Standarddesc). - Ausgabe:
{ files: [{ id, name, folder_id, size_bytes, mime_type, created_at, updated_at }], pagination: { limit, offset, count, has_more, next_offset } }. - Kein
total— die vollständige Treffermenge zu zählen ist auf diesem Pfad nicht günstig. Verwenden Siehas_more/next_offsetzum Blättern.
dataroom_get_file_metadata
Name am Bereichs-Endpunkt: get_file_metadata
Ruft Metadaten für eine einzelne Datei ab: Name, MIME-Typ, Größe, Ordnerpfad, Versionsliste sowie KI-Zusammenfassung/-Kategorie, falls vorhanden. Die Datei muss zum angegebenen Datenraum gehören; eine Datei in einem anderen Datenraum (selbst derselben Organisation) liefert null.
- Eingaben:
dataroom_id(erforderlich);file_id(erforderlich). - Ausgabe:
{ file: { id, name, mime_type, size_bytes, folder_id, folder_path, created_at, updated_at } | null, versions: [{ id, version_number, is_current, created_at }], ai_metadata: { summary, key_points, category, is_redacted } | null }.
dataroom_search
Name am Bereichs-Endpunkt: search_dataroom
Durchsucht Dateien nach Namen innerhalb eines einzelnen autorisierten Datenraums (Teilstring-Suche ohne Beachtung der Groß-/Kleinschreibung). Gelöschte Dateien sind ausgeschlossen.
- Eingaben:
dataroom_id(erforderlich);query(erforderlich, Teilstring des Dateinamens);limit(optional, 1–100, Standard 25);offset(optional, Standard 0). - Ausgabe:
{ files: [{ id, name, mime_type, size_bytes, created_at }], pagination: { limit, offset, count, has_more, next_offset } }. - Neueste zuerst, mit der ID als Tiebreaker, damit die Seiten stabil sind. Ist
has_moretrue, hat die Abfrage mehr Dateien gefunden, als zurückgegeben wurden — blättern Sie mitnext_offsetoder grenzen Sie die Abfrage ein. Es gibt keintotal.
Raum-Tools
dataroom_create
Erstellt einen Datenraum in der Organisation des Tokens.
- Scope:
write, und der Token-Inhaber muss dem Deal-Team angehören. Ein Token oder eine Verbindung, die auf bestimmte Datenräume beschränkt ist, wird abgewiesen (FORBIDDEN, CodePAT_ROOM_SCOPED); verwenden Sie eines bzw. eine ohne Beschränkung auf Datenräume. - Eingaben:
name(erforderlich, 1–100 Zeichen). Führende und nachgestellte Leerzeichen werden entfernt, und ein Name, der nur aus Leerzeichen besteht, wird abgewiesen (INVALID_ARGUMENT). - Ausgabe:
{ id, name }. Übergeben Sieidalsdataroom_idan die Ordner- und Datei-Tools. - Nicht idempotent. Jeder Aufruf erstellt einen neuen Raum. Ist das Ergebnis eines Aufrufs verloren gegangen,
suchen Sie den Raum mit
dataroom_list, bevor Sie erneut aufrufen, sonst erstellen Sie ein Duplikat. - Eine Organisation, deren Abonnement keine Schreibvorgänge erlaubt oder die ihr
Sitzplatzlimit überschritten hat, wird mit
QUOTA_EXCEEDEDabgewiesen.
Ordner-Tools
Erfordern den Scope write und eine Deal-Team-Rolle für den Datenraum.
dataroom_create_folder
Name am Bereichs-Endpunkt: create_folder
Erstellt einen Ordner in einem Datenraum. Verschachteln Sie ihn unter einem übergeordneten Ordner, oder lassen Sie diesen weg, um ihn im
Stammverzeichnis des Datenraums anzulegen. Weist einen doppelten Namen unter demselben übergeordneten Ordner mit einem
CONFLICT ab.
- Eingaben:
dataroom_id(erforderlich);name(erforderlich, 1–255 Zeichen);parent_folder_id(optional — null/weggelassen für das Stammverzeichnis des Datenraums). - Ausgabe:
{ folder: { id, name, parent_folder_id } }. DieCONFLICT- Meldung nennt die ID des kollidierenden Ordners, sodass Sie den übergeordneten Ordner nicht erneut auflisten müssen, um ihn zu finden.
dataroom_rename_folder
Name am Bereichs-Endpunkt: rename_folder
Benennt einen Ordner um. Der Ordner muss zur Organisation des Aufrufers gehören.
- Eingaben:
folder_id(erforderlich);name(erforderlich, 1–255 Zeichen). - Ausgabe:
{ folder: { id, name } }.
dataroom_delete_folder
Name am Bereichs-Endpunkt: delete_folder
Löscht einen Ordner per Soft Delete samt seinem gesamten Unterbaum — jeden verschachtelten Unterordner und
jede Datei darin. In einem echten Datenraum können das Hunderte von Dokumenten
aus einer einzigen Ordner-ID sein, daher meldet das Ergebnis genau, wie viele Ordner und Dateien
entfernt wurden. Übergeben Sie dry_run: true, um diese Zahlen zu erhalten, ohne etwas zu löschen.
Zeilen werden als gelöscht markiert, nie endgültig entfernt, und die gesamte Kaskade lässt sich
mit restore_folder rückgängig machen.
- Eingaben:
folder_id(erforderlich);dry_run(optionaler Boolean — nur Vorschau). - Ausgabe:
{ deleted, dry_run, folder_id, folder_name, affected: { folders, files }, restore_with: "restore_folder" }. - Ein Probelauf ändert nichts und erfasst keine Löschung im Audit-Trail.
dataroom_restore_folder
Name am Bereichs-Endpunkt: restore_folder
Macht ein delete_folder rückgängig. Stellt den Ordner und alles wieder her, was diese Löschung mit ihm
entfernt hat — alles, was separat und früher gelöscht wurde, bleibt gelöscht. Gibt einen Konflikt zurück,
wenn der übergeordnete Ordner noch gelöscht ist (stellen Sie diesen zuerst wieder her) oder wenn ein aktiver Ordner
inzwischen den Namen belegt; in beiden Fällen nennt die Meldung die ID des blockierenden Ordners.
- Eingaben:
folder_id(erforderlich);dry_run(optionaler Boolean — nur Vorschau). - Ausgabe:
{ restored, dry_run, folder_id, folder_name, affected: { folders, files } }. - Das Löschen eines Ordners lässt sich verlustfrei rückgängig machen, und zwar bewusst anders als das Löschen einer Datei.
Die Kaskade verändert den Speicherzähler Ihrer Organisation nicht und verwirft nicht
die Suchindex-Chunks der Dateien, daher schreibt
restore_foldernichts gut — es wurde nichts abgebucht — und die wiederhergestellten Dateien bleiben durchsuchbar.delete_file/restore_fileweiter unten tun beides. Das Löschen eines Ordners voller Dokumente ist daher nicht derselbe Abrechnungsvorgang wie das Löschen jedes einzelnen dieser Dokumente.
dataroom_move_folder
Name am Bereichs-Endpunkt: move_folder
Hängt einen Ordner innerhalb desselben Datenraums um. Verschachteln Sie ihn unter einem anderen Ordner oder verschieben Sie ihn in das Stammverzeichnis des Datenraums. Weist das Verschieben eines Ordners in sich selbst oder einen Nachfahren (Zyklus), in einen anderen Datenraum oder an eine Stelle ab, an der bereits ein gleichrangiger Ordner mit demselben Namen existiert.
- Eingaben:
folder_id(erforderlich);new_parent_folder_id(optional — null/weggelassen für das Stammverzeichnis des Datenraums). - Ausgabe:
{ folder: { id, name, parent_folder_id, previous_parent_folder_id } }. Übergeben Sieprevious_parent_folder_idalsnew_parent_folder_idzurück, um das Verschieben rückgängig zu machen.
Datei-Tools
Änderungen an Dateien erfordern den Scope write; get_file_download_url erfordert read
plus Dokumentinhalt lesen auf dem Token.
Das Hochladen wird vermittelt, und MCP überträgt niemals die Bytes. Tool-Argumente sind
JSON, daher hat das Protokoll keinen Binärkanal: request_file_upload erzeugt eine
vorsignierte URL, und Ihr Client sendet den Inhalt per PUT direkt dorthin. Ein Client, der
keinen HTTP-PUT mit einem rohen Binär-Body absetzen kann, kann einen Upload überhaupt nicht abschließen
— gut zu wissen, bevor Sie beginnen, nicht erst danach.
Welches Tool den Upload abschließt, hängt davon ab, ob bereits eine Datei dieses Namens
vorhanden ist, und Sie müssen das nicht selbst ermitteln: request_file_upload gibt ein
next_step-Feld zurück, das das aufzurufende Tool nennt.
request_file_upload gibt zurück | Bedeutung | Abschließen mit |
|---|---|---|
is_new_version: false, next_step: "register_file" | Keine aktive Datei gleichen Namens — ein ausstehender Datensatz wurde mit Version 1 angelegt | register_file |
is_new_version: true, next_step: "finalise_file_version" | Eine aktive Datei gleichen Namens existiert — dieser Upload wird eine neue Version davon | finalise_file_version |
Rufen Sie das Tool auf, das next_step nennt. register_file schließt ausschließlich Version 1 ab und
weist alles andere ab; wer im Zweig für neue Versionen darauf zugreift, lässt den Aufruf scheitern.
dataroom_request_file_upload
Name am Bereichs-Endpunkt: request_file_upload
Fordert eine vorsignierte Upload-URL für eine Datei in einem Datenraum an. Gibt die URL und die
Header für den PUT der Bytes zurück, die Datei-ID und next_step — das Tool, das
genau diesen Upload abschließt. Existiert im Zielordner bereits eine aktive Datei gleichen Namens,
ist is_new_version true, und die zurückgegebene ID und
version_number beziehen sich auf diese vorhandene Datei.
- Scope:
write. - Eingaben:
dataroom_id(erforderlich);file_name(erforderlich, mit Dateiendung);file_size(erforderlich, exakte Bytes, positive Ganzzahl);mime_type(erforderlich);folder_id(optional — weglassen für das Stammverzeichnis des Datenraums). - Ausgabe:
{ upload_url, headers, file_id, s3_key, is_new_version, version_number, next_step }—next_stepist"register_file"oder"finalise_file_version". - Dieses Tool überträgt keine Bytes; es vermittelt nur die URL. Ist der Objektspeicher nicht konfiguriert, schlägt der Aufruf sofort fehl, statt eine URL zurückzugeben, die nicht funktionieren kann.
dataroom_register_file
Name am Bereichs-Endpunkt: register_file
Schließt einen ausstehenden ersten Upload ab, nachdem die Bytes per PUT an die URL aus
request_file_upload gesendet wurden: markiert die Datei als aktiv, erhöht den Speicherverbrauch der Organisation und erfasst
Version 1. Rufen Sie es auf, wenn request_file_upload is_new_version: false zurückgegeben hat —
dessen next_step nennt dieses Tool.
- Scope:
write. - Eingaben:
file_id(erforderlich, die ausstehende ID ausrequest_file_upload);s3_key(optional);size_bytes(optional — wird aus dem hochgeladenen Objekt abgeleitet, wenn weggelassen). - Ausgabe:
{ file_id, status: "active", version_number: 1 }. - Nur Version 1, und das wird durchgesetzt. Eine Datei, die bereits aktiv ist oder
bereits eine Version trägt, wird abgewiesen — die Ablehnung nennt
finalise_file_versionals Tool für Version 2 und höher. - Der Speicherschlüssel wird serverseitig abgeleitet, und dem
s3_keydes Clients wird nie vertraut. Er ist optional; wenn Sie ihn senden, muss er dem Schlüssel entsprechen, denrequest_file_uploadzurückgegeben hat, sonst wird der Aufruf abgewiesen.
dataroom_finalise_file_version
Name am Bereichs-Endpunkt: finalise_file_version
Schließt eine neue Version einer vorhandenen Datei ab, nachdem die Bytes per PUT an die URL gesendet wurden,
die request_file_upload mit is_new_version: true zurückgegeben hat. Dies ist das MCP-
Gegenstück zum Ersetzen eines Dokuments in der Oberfläche und das Tool, das next_step in
diesem Zweig nennt.
- Scope:
write. - Eingaben:
file_id(erforderlich);version_number(erforderlich — dieversion_number, dierequest_file_uploadzurückgegeben hat). - Ausgabe:
{ file_id, version_id, version_number, size_bytes, is_current: true, previous_version_number, previous_version_id, undo_with: "restore_file_version" }. version_numbermuss genau die nächste Version für diese Datei sein. Sie wird geprüft, nicht geraten: Jeder andere Wert wird abgewiesen, statt stillschweigend geschrieben zu werden, und der Speicherschlüssel wird serverseitig daraus abgeleitet.- Die neue Version wird zur aktuellen, und die vorherige bleibt im
Verlauf erhalten. Übergeben Sie
previous_version_idanrestore_file_version, um dies rückgängig zu machen. - Eine Datei, deren erster Upload nicht abgeschlossen ist, wird abgewiesen — schließen Sie Version 1
zuerst mit
register_fileab. Der Aufruf schlägt auch fehl, wenn die Bytes noch nicht tatsächlich im Speicher liegen, statt eine Version ohne Inhalt dahinter zu erfassen.
dataroom_restore_file_version
Name am Bereichs-Endpunkt: restore_file_version
Macht eine frühere Version einer Datei wieder zur aktuellen — das Rückgängigmachen von
finalise_file_version. Es verschiebt die Aktuell-Markierung und richtet die Datei auf
diese Version aus; es legt keine neue Versionszeile an, sodass der Versionsverlauf
eine getreue Liste der tatsächlich hochgeladenen Revisionen bleibt.
- Scope:
write. - Eingaben:
file_id(erforderlich);version_id(erforderlich — muss zu dieser Datei gehören;get_file_metadatalistet die Versions-IDs der Datei auf). - Ausgabe:
{ file_id, version_id, version_number, already_current, new_version_created: false }. already_current: truebedeutet, dass die Version bereits die aktuelle war und sich nichts geändert hat — ein No-op, kein Fehler.- Es gibt kein separates Tool zum Auflisten von Versionen:
get_file_metadatagibt bereits die Versionen der Datei mit ihren IDs, Nummern und dem Aktuell-Flag zurück.
dataroom_rename_file
Name am Bereichs-Endpunkt: rename_file
Benennt eine Datei um — nur Metadaten. Dabei wird keine neue Version erstellt;
Versionierung dient dem Ersetzen von Inhalten, nicht dem Umbenennen. Namen müssen unter
den aktiven Dateien im selben Ordner eindeutig sein; eine Kollision liefert einen CONFLICT, der die vorhandene
Datei nennt.
- Scope:
write. - Eingaben:
file_id(erforderlich);name(erforderlich, 1–255 Zeichen). - Ausgabe:
{ file_id, name, previous_name, changed }. Der zurückgegebenenamewird aus dem Speicher zurückgelesen, ist also das, was tatsächlich gespeichert wurde —changedist false, wenn sich der gespeicherte Name nicht geändert hat.
dataroom_move_file
Name am Bereichs-Endpunkt: move_file
Verschiebt eine Datei in einen anderen Ordner im selben Datenraum oder in das Stammverzeichnis des Datenraums. Verschiebungen zwischen Datenräumen werden abgewiesen: Ein Datenraum ist eine Berechtigungsgrenze, und Inhalte über eine solche hinweg umzusiedeln würde ändern, wer sie lesen kann. Weist ein Verschieben ab, wenn im Ziel bereits eine aktive Datei gleichen Namens liegt.
- Scope:
write. - Eingaben:
file_id(erforderlich);folder_id(optional — null/weggelassen für das Stammverzeichnis des Datenraums). - Ausgabe:
{ file_id, name, folder_id, previous_folder_id, moved }. Übergeben Sieprevious_folder_idalsfolder_idzurück, um das Verschieben rückgängig zu machen.
dataroom_delete_file
Name am Bereichs-Endpunkt: delete_file
Löscht eine Datei. Das Ergebnis gibt den Namen der tatsächlich gelöschten Datei zurück,
sodass eine falsche ID in der Antwort sichtbar wird. Die Datei und ihre Versionen werden
für Aufbewahrung und Audit erhalten, nie gelöscht, und restore_file holt sie zurück.
- Scope:
write. - Eingaben:
file_id(erforderlich). - Ausgabe:
{ file_id, status: "deleted", name, folder_id, restore_with: "restore_file" }. - Speicher wird nur für einen tatsächlich abgeschlossenen Upload gutgeschrieben. Eine Datei, deren Bytes angekommen sind, gibt ihre Größe an den Speicherzähler Ihrer Organisation zurück. Eine Datei, die noch auf ihren Upload wartet, wurde nie berechnet, daher verändert ihr Löschen den Zähler um nichts — das Löschen ist zählerneutral, keine Rückerstattung von Bytes, die Sie nie gespeichert haben.
- Beim Löschen werden außerdem die Suchindex-Chunks der Datei verworfen, sodass das Dokument
sofort aus der Dokumentsuche verschwindet.
restore_filekann diese nicht zurückholen — siehe unten. - Das Tool löst immer nur eine aktive Datei auf, daher liefert ein zweiter Aufruf mit
derselben ID
NOT_FOUND, statt erneut etwas zu löschen. Der Speicherzähler kann für eine Datei nicht zweimal belastet werden.
dataroom_restore_file
Name am Bereichs-Endpunkt: restore_file
Macht ein delete_file rückgängig: holt eine per Soft Delete gelöschte Datei zurück in den aktiven Zustand und stellt die Zeile
sowie die Speicherabrechnung wieder her, die das Löschen rückgängig gemacht hatte. Die
Suchindex-Chunks der Datei werden nicht wiederhergestellt — sie werden beim Löschen verworfen —, daher ist die Datei aktiv und
herunterladbar, muss aber neu indexiert werden, bevor die Dokumentsuche sie wieder findet.
search_index_restored ist immer false und sagt das auch, statt ein
verlustfreies Rückgängigmachen zu suggerieren.
- Scope:
write. - Eingaben:
file_id(erforderlich). - Ausgabe:
{ restored, file_id, name, folder_id, storage_bytes_restored, search_index_restored: false }.
Wann eine Wiederherstellung abgewiesen wird. Sie schlägt fehl, statt einen Konflikt zu überdecken, und nennt die blockierende Zeile, wo es eine gibt:
| # | Bedingung | error.code | Was zu tun ist |
|---|---|---|---|
| 1 | Keine solche Datei, oder sie gehört nicht Ihnen | NOT_FOUND | ID prüfen. |
| 2 | Die Datei ist nicht gelöscht — sie ist bereits aktiv | CONFLICT | Nichts wiederherzustellen. |
| 3 | Der Upload der Datei wurde nie abgeschlossen | CONFLICT | Nichts wiederherzustellen: Ihre Bytes sind nie angekommen, daher gibt es kein Dokument, das zurückgeholt werden könnte. Laden Sie sie stattdessen erneut hoch. |
| 4 | Der enthaltende Ordner ist noch gelöscht | CONFLICT | Zuerst restore_folder — das holt auch die mit ihm gelöschten Dateien zurück. |
| 5 | Eine aktive Datei belegt inzwischen den Namen in diesem Ordner | CONFLICT | Benennen Sie die Datei um, die den Namen belegt, und versuchen Sie es erneut. |
Dies sind Codes im Payload, keine HTTP-Status — siehe Wie ein Fehler gemeldet wird.
Die Prüfungen laufen in der oben nummerierten Reihenfolge, und Ihnen wird die erste fehlgeschlagene gemeldet. Der Fall „Upload nie abgeschlossen“ (3) wird daher nach den Prüfungen auf „nicht gefunden“ und „nicht gelöscht“, aber vor den Ordner- und Namensprüfungen gemeldet: Eine Datei, deren Bytes nie angekommen sind, kann unabhängig von ihrer Ordner- oder Namenssituation nicht wiederhergestellt werden, daher ist es sinnlos, Sie zur Behebung eines der beiden zu schicken.
dataroom_get_file_download_url
Name am Bereichs-Endpunkt: get_file_download_url
Ruft eine kurzlebige Download-URL für eine Datei ab. Der Aufrufer muss für die Datei berechtigt sein (die Lese-/Download-Berechtigung pro Datei). Die URL liefert dieselbe Kopie, die Sie beim Download im Browser erhalten: mit Wasserzeichen, wenn der Raum Downloads mit Wasserzeichen versieht, und die geschwärzte Kopie eines geschwärzten Dokuments für einen Empfänger außerhalb Ihrer Organisation. Sie läuft nach wenigen Minuten ab.
- Scope:
read, plus Dokumentinhalt lesen auf dem Token. Ohne diese Berechtigung wird der Aufruf mitGRANT_REQUIREDabgewiesen. - Limit: höchstens 10 Aufrufe pro Minute und Token, da jeder Aufruf eine
geschützte Kopie vorbereitet. Darüber hinaus
RATE_LIMITED. - Kann eine geschützte Kopie nicht rechtzeitig vorbereitet werden, wird der Aufruf mit
UNAVAILABLEund ohne Link abgewiesen; versuchen Sie es erneut oder laden Sie die Datei in Waafir herunter. - Eingaben:
file_id(erforderlich). - Ausgabe:
{ download_url, expires_in_seconds }.
Tools für Dokumenttext
Ein Tool, um den extrahierten Text eines Dokuments zu lesen, statt die Datei selbst herunterzuladen.
dataroom_get_file_text
Name am Bereichs-Endpunkt: get_file_text
Liest den extrahierten Text eines Dokuments seitenweise. Gibt nummerierte
Segmente zurück – bei einem PDF ein Segment pro Seite, sofern die Seite nicht
sehr lang ist – sowie einen pagination-Block, sodass Sie ein langes Dokument
mit offset durchlaufen können.
Zwei Dinge machen dieses Tool strenger als einen Metadaten-Lesezugriff:
- Sie müssen die Datei herunterladen dürfen, nicht nur ansehen. Eine reine Ansichtsberechtigung genügt nicht, und ein Token, das vom Dokument ausgeschlossen ist, wird abgewiesen.
- Wurde das Dokument geschwärzt und gehören Sie nicht zum Deal-Team, erhalten
Sie den Text der geschwärzten Version, und
sourcegibt an, welches Artefakt Sie bekommen haben. Einem Leser außerhalb des Deal-Teams wird nie stillschweigend das Original ausgehändigt.
Jeder erfolgreiche Aufruf wird im Audit-Log der Organisation erfasst, genauso wie ein Dokumentabruf im Produkt.
- Scope:
read, plus Dokumentinhalt lesen auf dem Token. Ohne diese Berechtigung wird der Aufruf mitGRANT_REQUIREDabgewiesen;dataroom_get_file_metadataunddataroom_summarise_fileliefern weiterhin die Zusammenfassung des Dokuments. - Eingaben:
file_id(erforderlich);dataroom_id(optional – wird, sofern angegeben, gegen den Datenraum der Datei geprüft, und eine Abweichung ergibtNOT_FOUND, statt zu bestätigen, dass die Datei anderswo existiert);limit(optional, 1–5, Standard 3);offset(optional, Standard 0). - Ausgabe:
{ file_id, file_name, source, segment_max_chars, segments, pagination }.sourceist"original"oder"redacted".paginationenthält eintotal. - Eine Datei ohne gespeichertes Objekt – eine Notiz, deren Inhalt inline
gespeichert ist – gibt
NOT_FOUNDmit „no extractable content“ zurück. - Eine Datei, deren Typ keinen extrahierbaren Text hat (etwa ein Archiv), wird
mit
400abgewiesen, eine gespeicherte Datei über 50 MB mit413(FILE_TOO_LARGE). Beides gilt nur, wenn der Text der Datei noch nicht extrahiert wurde (bereits extrahierter Text wird vorrangig ausgeliefert), wird abgewiesen, bevor das Dokument abgerufen wird, und ist in keinem Fall ein Fehler, bei dem ein späterer Neuversuch hilft. - Dieses Tool erzeugt die beiden Codes für späteren Neuversuch:
UPSTREAM_ERROR, wenn das gespeicherte Dokument nicht abgerufen werden kann oder die Textextraktion fehlschlägt, undUNAVAILABLE, wenn der Audit-Eintrag für den Abruf fehlschlägt – in diesem Fall wird der Text bewusst zurückgehalten, statt ihn ohne Protokollierung offenzulegen. Bei beiden lohnt sich ein Neuversuch, bevor Sie das Dokument als nicht lesbar behandeln.
Berechtigungs-Tools
Diese Tools lesen und ändern, wer was sehen darf. Die drei Lese-Tools
erfordern nur den Scope read (die beiden Verzeichnis-Tools zusätzlich eine
Deal-Team-Rolle); die vier Tools zum Gewähren und Widerrufen erfordern den Scope
admin und einen Token-Inhaber, der Admin oder Manager der Organisation ist.
Ein Token trägt bei eingeschränkten Dateien nie die Sonderrechte von Owner
oder Admin. In der App sieht ein Owner oder Admin der Organisation jede
eingeschränkte Datei; über ein Token erreicht er eine solche Datei nur, wenn er
sie erstellt hat oder eine Berechtigung darauf besitzt – genau wie jedes andere
Mitglied. Ein Datei-Tool, das bei einer solchen Datei abgewiesen wird, antwortet
mit NOT_FOUND und demselben Text wie bei einer nicht existierenden Datei („File
not found in the requested dataroom, or not readable by this credential“), sodass
die Antwort nie bestätigt, dass eine eingeschränkte Datei vorhanden ist.
dataroom_get_file_permissions
Name am Bereichs-Endpunkt: get_file_permissions
Listet die Berechtigungen auf einer Datei auf (direkte und vom Ordner geerbte). Entspricht der Ansicht der Dateiberechtigungen in der Oberfläche.
- Scope:
read. - Eingaben:
dataroom_id(erforderlich);file_id(erforderlich);limit(optional, 1–200, Standard 50);offset(optional, Standard 0). - Ausgabe:
{ permissions: [{ user_id, can_read, can_download, access_revoked, expires_at, granted_by, created_at, source, source_folder_name?, source_folder_id?, user_email?, user_name?, granted_by_email? }], pagination: { limit, offset, count, has_more, next_offset, total }, identities_visible }(sourceist"direct"oder"inherited"). - Die Berechtigungen werden nach
created_at, dannuser_id, dannsource, dannsource_folder_idsortiert, sodass die Seiten über mehrere Aufrufe stabil bleiben.totalist die Gesamtzahl der Berechtigungen auf der Datei. - Die Identitätsfelder (
user_email,user_name,granted_by_email) folgen derselben Sichtbarkeitsregel wie die Verzeichnis-Tools unten: Sie erscheinen für Aufrufer aus dem Deal-Team, Identitäten von Investoren erfordern zusätzlich einen Admin oder Manager der Organisation, und wo Sie keine Berechtigung haben, fehlen die Schlüssel, stattnullzu sein.identities_visiblezeigt Ihnen, welcher Fall vorliegt; die Berechtigungen selbst werden immer aufgelistet.
dataroom_list_users
Name am Bereichs-Endpunkt: list_dataroom_users
Listet die Benutzer auf, die eine aktive Zugriffsberechtigung für einen Datenraum
haben, mit der user_id, die die Berechtigungs-Tools benötigen, sowie E-Mail-Adresse
und Namen jedes Berechtigten. Dies ist meist der erste Aufruf, wenn Sie eine
user_id benötigen.
- Scope:
read, und eine Deal-Team-Rolle in der Organisation des Datenraums (dieselbe Hürde wie bei der Team-Seite). - Eingaben:
dataroom_id(erforderlich);limit(optional, 1–200, Standard 50);offset(optional, Standard 0). - Ausgabe:
{ users: [{ user_id, email, name, is_deal_team, org_role, permission, granted_at, expires_at }], pagination: { limit, offset, count, has_more, next_offset, total }, investor_rows_visible }. - Identitäten von Investoren werden ausgelassen, sofern Sie nicht Admin oder
Manager der Organisation sind;
investor_rows_visiblegibt an, welche Menge Sie erhalten haben. - Listet nur explizit Berechtigte auf. Owner und Admins der Organisation haben
impliziten Zugriff ohne Berechtigungszeile und erscheinen nicht – ermitteln Sie
diese mit
find_user_by_email.
dataroom_find_user_by_email
Name am Bereichs-Endpunkt: find_user_by_email
Löst eine E-Mail-Adresse in die user_id auf, die die Berechtigungs-Tools
benötigen, zusammen mit der Rolle des Benutzers in der Organisation und seiner
aktuellen Berechtigung in diesem Datenraum.
- Scope:
read, und eine Deal-Team-Rolle in der Organisation des Datenraums. Die Auflösung eines Investors erfordert zusätzlich einen Admin oder Manager der Organisation. - Eingaben:
dataroom_id(erforderlich);email(erforderlich, Abgleich ohne Beachtung der Groß-/Kleinschreibung). - Ausgabe:
{ found: true, user: { user_id, email, name, org_role, dataroom_permission } }oder{ found: false }. Eindataroom_permissionvonnullbedeutet, dass der Benutzer zur Organisation gehört, aber noch keinen Zugriff auf diesen Raum hat – laden Sie ihn zuerst ein. - Dies ist keine globale Verzeichnissuche: Aufgelöst werden nur Benutzer
innerhalb der Organisation des Datenraums oder solche mit aktivem Zugriff darauf.
Eine unbekannte Adresse, ein Benutzer außerhalb Ihres Mandanten und ein
Benutzer, den Sie nicht sehen dürfen, liefern alle ein identisches
{ found: false }, sodass eine negative Antwort nie verrät, ob ein Konto existiert.
dataroom_set_file_permissions
Name am Bereichs-Endpunkt: set_file_permissions
Gewährt oder aktualisiert die Lese-/Download-Berechtigung eines Benutzers für
eine Datei. Ein read-/write-Token oder ein Inhaber, der weder Admin noch
Manager der Organisation ist, wird abgewiesen.
- Scope:
admin. - Eingaben:
dataroom_id(erforderlich);file_id(erforderlich);user_id(erforderlich);can_read(erforderlich, boolesch);can_download(erforderlich, boolesch);expires_at(optionaler ISO-Zeitstempel, muss in der Zukunft liegen). - Ausgabe:
{ success: true, effective: { can_read, can_download } }– die Entscheidung nach der Gewährung, die Dateieinschränkungen und Ordnervererbung berücksichtigt und daher von Ihrer Anforderung abweichen kann. - Dieses Tool gewährt Zugriff; es kann ihn nicht entziehen. Die Übergabe von
can_read: falseschreibt eine aktive Berechtigung mit verweigertem Lesezugriff, die andere Berechtigungen (Mitgliedschaft in der Organisation, eine Datenraum-Berechtigung, Ordnervererbung) dennoch übersteuern können. Um den Zugriff eines Benutzers auf eine Datei tatsächlich zu entziehen, verwenden Sierevoke_file_permission.
dataroom_revoke_file_permission
Name am Bereichs-Endpunkt: revoke_file_permission
Entfernt die direkte Berechtigung eines Benutzers für eine Datei (Soft-Revoke:
Die Zeile bleibt für den Audit-Trail erhalten). Gibt revoked: false zurück,
wenn der Benutzer keine direkte Berechtigung für die Datei hatte.
- Scope:
admin. - Eingaben:
dataroom_id(erforderlich);file_id(erforderlich);user_id(erforderlich). - Ausgabe:
{ success: true, revoked }. - Betrifft nur die direkte Berechtigung. Von einer Ordnerberechtigung
geerbter Zugriff bleibt unberührt und muss am Ordner widerrufen werden.
Umkehrbar durch erneutes Gewähren mit
set_file_permissions.
dataroom_invite_user
Name am Bereichs-Endpunkt: invite_user_to_dataroom
Gewährt einem bekannten Benutzer Zugriff auf Datenraumebene mit einer bestimmten Berechtigungsstufe – eine direkte Zugriffsberechtigung (keine E-Mail-Einladung). Idempotent (Upsert).
- Scope:
admin. - Eingaben:
dataroom_id(erforderlich);user_id(erforderlich);permission(erforderlich – einer der Werteviewer,downloader,contributor,manager);expires_at(optionaler ISO-Zeitstempel, muss in der Zukunft liegen). - Ausgabe:
{ success: true, grant_id }.
dataroom_remove_user
Name am Bereichs-Endpunkt: remove_user_from_dataroom
Widerruft den Zugriff eines Benutzers auf Datenraumebene (Soft-Revoke: setzt
revoked_at und erhält den Audit-Trail). Gibt revoked: false zurück, wenn der
Benutzer keine aktive Berechtigung hatte.
- Scope:
admin. - Eingaben:
dataroom_id(erforderlich);user_id(erforderlich). - Ausgabe:
{ success: true, revoked }.
Tools zur Raumverwaltung
Ordnerberechtigungen, Berechtigungen für viele Dateien auf einmal und das
Download-Wasserzeichen des Raums. Jedes Tool führt dieselben Prüfungen aus und
schreibt dieselben Zeilen wie der Waafir-Bildschirm, dem es entspricht. Die
schreibenden Tools erfordern den Scope admin und einen Token-Inhaber, der
Admin der Organisation ist. Empfänger sind immer eine user_id (aus
find_user_by_email oder list_dataroom_users), nie eine E-Mail-Adresse.
dataroom_get_folder_permissions
Listet die direkten Berechtigungen auf einem Ordner auf und gibt an, ob er eingeschränkt ist (selbst oder über einen eingeschränkten übergeordneten Ordner).
- Scope:
read, und der Token-Inhaber muss zum Deal-Team gehören. - Eingaben:
dataroom_id(erforderlich);folder_id(erforderlich). - Ausgabe:
{ folder_id, restricted, effectively_restricted, permissions: [{ user_id, can_read, can_download, expires_at, access_revoked, user_email?, user_name? }] }. Die Identitätsschlüssel fehlen, wo Sie die betreffende Person nicht sehen dürfen. - Ein Ordner, den Sie nicht sehen können, antwortet mit
NOT_FOUND, genau wie ein nicht existierender.
dataroom_set_folder_permissions
Gewährt Benutzern Zugriff auf einen Ordner oder verweigert ihn mit
can_read: false, optional für den gesamten Unterbaum.
- Scope:
admin. - Eingaben:
dataroom_id,folder_id,grants(erforderlich:[{ user_id, can_read, can_download, expires_at? }]);recursive(Standardfalse). - Ausgabe:
{ success: true, recursive, granted, skipped: { count, items } }. - Jeder Berechtigte muss bereits im Raum sein. Ein
expires_atin der Vergangenheit wird abgewiesen. Eine Berechtigung, die durch eine Verweigerung auf einem übergeordneten Ordner aufgehoben würde, wird abgewiesen (CONFLICT), bevor etwas geschrieben wird. Eine rekursive Berechtigung überspringt die Unterelemente, für die der Berechtigte eine Verweigerung hat, und listet sie inskippedauf. Berechtigte erhalten die In-App-Benachrichtigung „Zugriff gewährt“.
dataroom_revoke_folder_permission
Widerruft die direkte Berechtigung eines Benutzers auf einem Ordner oder hebt seine Verweigerung auf.
- Scope:
admin. - Eingaben:
dataroom_id,folder_id,user_id(alle erforderlich). - Ausgabe:
{ success: true, revoked }.revoked: falsebedeutet, dass keine aktive Berechtigung bestand. - Dies wirkt nicht kaskadierend: Berechtigungen, die eine rekursive Gewährung auf den Unterelementen des Ordners geschrieben hat, bleiben bestehen.
dataroom_bulk_set_file_permissions
Gewährt denselben Benutzern Zugriff auf viele Dateien auf einmal. Im
mode: "add" (Standard) wird nur hinzugefügt: Ein Feld, das Sie weglassen,
entzieht nie Zugriff. Im mode: "replace" wird jede Berechtigung genau wie
angegeben überschrieben, sodass Download entfernt, ein Ablaufdatum gelöscht oder
widerrufener Zugriff wiederhergestellt werden kann. Replace erfolgt in zwei Schritten: Der erste Aufruf liefert eine Vorschau und ein confirm_token, und
die Wiederholung mit dem Token wendet sie an, sofern sich zwischenzeitlich keine
Berechtigung in der Auswahl geändert hat.
- Scope:
admin. - Eingaben:
dataroom_id,file_ids(bis zu 200),grants(alle erforderlich);mode;confirm_token. - Ausgabe:
{ success: true, mode, total_grants, left_revoked_user_ids }. - Eine Datei-ID, die nicht im Raum liegt oder die Sie nicht sehen können, führt zur Abweisung der gesamten Anfrage mit
NOT_FOUND. - Jede Datei muss im Raum liegen und für Sie sichtbar sein, und jeder Berechtigte muss bereits im Raum sein. Würde eine Ordnerverweigerung irgendeine Berechtigung aufheben, wird die gesamte Anfrage abgewiesen, bevor eine Datei geschrieben wird.
- Wurde der Zugriff eines Berechtigten widerrufen, stellt ein
addihn nicht wieder her, und der Berechtigte wird inleft_revoked_user_idsaufgeführt.
dataroom_bulk_revoke_file_permissions
Widerruft die direkten Berechtigungen der angegebenen Benutzer auf vielen Dateien auf einmal. Ordnerberechtigungen und Raumzugriff bleiben unberührt.
- Scope:
admin. - Eingaben:
dataroom_id,file_ids(bis zu 200),user_ids(alle erforderlich). - Ausgabe:
{ success: true, revoked_count }. - Eine Datei-ID, die nicht im Raum liegt oder die Sie nicht sehen können, führt zur Abweisung der gesamten Anfrage mit
NOT_FOUND.
dataroom_get_watermark_settings
Liest die Download-Wasserzeichenmodi des Raums für Einzel- und Massendownloads:
two_layer (die Identität des Herunterladenden plus ein Durchgang mit IP-Adresse
und Datum pro Download) oder static (nur Identität). Nur lesend: Ändern Sie
die Modi in den Waafir-Einstellungen.
- Scope:
read, und der Token-Inhaber muss Admin der Organisation und Mitglied des Deal-Teams sein. - Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ dataroom_id, single, bulk, stored: { single, bulk } }. Einnullinstoredbedeutet, dass der Raum den Wert nie gesetzt hat, sodass der Standard gilt.
dataroom_archive
Archiviert einen Datenraum, sodass er aus den Raumlisten verschwindet. Zwei Schritte: Der erste Aufruf ändert nichts und liefert eine Vorschau (den Namen
des Raums und wie viele Dateien, Ordner, Personen mit Zugriff und aktive
Freigabe-Links er hat) sowie ein confirm_token. Wiederholen Sie den Aufruf mit
dem Token, um zu archivieren.
- Scope:
admin, und der Token-Inhaber muss Owner oder Admin der Organisation sein. - Eingaben:
dataroom_id(erforderlich);confirm_token. - Ausgabe:
{ success: true, dataroom_id, name, archived: true, restore_with: 'dataroom_restore' }. - Das Archivieren widerruft keine Zugriffe oder Berechtigungen, und nichts
wird gelöscht. Der Raum verschwindet aus den Listen, und Lesezugriffe auf
Raumebene (
get_dataroom,list_files,list_folders, Suche, Q&A, KI-Fragen) antworten mitNOT_FOUND, bis er wiederhergestellt ist. Ein direkter Link zu einer seiner Dateien öffnet diese weiterhin.dataroom_restoreholt den Raum zurück, bewahren Sie also diedataroom_idauf. Der letzte aktive Datenraum kann nicht archiviert werden (CONFLICT). Es gibt kein Tool, das einen Datenraum löscht.
dataroom_restore
Stellt einen Datenraum wieder her, den Ihre Organisation archiviert hat. Er erscheint wieder in den Raumlisten, und alles, was das Archivieren ausgeblendet hat, kehrt mit ihm zurück: KI-Suche, Digests, Investor-Updates, Q&A und die Add-ons des Raums. Ordner, Dateien und Zugriffe sind wie zuvor, da das Archivieren nichts davon verändert hat. Ein Aufruf, kein Bestätigungsschritt.
- Scope:
admin, und der Token-Inhaber muss Owner oder Admin der Organisation sein. - Eingaben:
dataroom_id(erforderlich): die vondataroom_archivezurückgegebene ID. - Ausgabe:
{ success: true, dataroom_id, name, archived: false }. - Ein nicht archivierter Raum wird abgewiesen (
CONFLICT, CodeNOT_ARCHIVED). Ein Raum, der vom Waafir-Support oder zusammen mit seiner Organisation archiviert wurde, wird abgewiesen (CONFLICT, CodeSUPPORT_RESTORE_ONLY): Nur der Support kann ihn wiederherstellen. - Abgewiesen, solange das Abonnement inaktiv ist oder das Team sein Sitzplatzlimit überschreitet.
dataroom_rename
Benennt einen Datenraum um.
- Scope:
write, und der Token-Inhaber muss zum Deal-Team gehören. - Eingaben:
dataroom_id,name(beide erforderlich). Der Name wird um führende und nachgestellte Leerzeichen bereinigt und muss 1 bis 100 Zeichen lang sein. - Ausgabe:
{ success: true, dataroom_id, name }. - Der Audit-Trail erfasst den alten und den neuen Namen.
Team-Tools
Das Team der Organisation gilt organisationsweit, daher wird ein Token, das auf
bestimmte Datenräume beschränkt ist, abgewiesen (FORBIDDEN, Code PAT_ROOM_SCOPED).
dataroom_team_list_members
Listet die aktiven Mitglieder der Organisation auf. Ausstehende Einladungen sind nicht enthalten.
- Scope:
read, und der Token-Inhaber muss zum Deal-Team gehören. - Eingaben: keine.
- Ausgabe:
{ members: [{ membership_id, user_id, email, name, role, last_active_at }] }.roleist einer der Werteowner,adminodermember.
Die folgenden schreibenden Tools benötigen ein Token mit Scope admin, dessen
Inhaber Owner oder Admin der Organisation ist. Die vier als zweistufig
gekennzeichneten Tools liefern beim ersten Aufruf eine Vorschau und ein
confirm_token und handeln erst, wenn sie damit wiederholt werden.
dataroom_team_invite_member
Lädt jemanden per E-Mail ein. Zwei Schritte; die Bestätigung versendet die Einladungs-E-Mail.
- Scope:
admin, plus die Berechtigung An Personen außerhalb Ihrer Organisation senden. - Eingaben:
email,role(owner,adminodermember) (erforderlich);confirm_token. - Ausgabe:
{ membership_id, email, role, status: "pending" }. Nie der Einladungslink. - Nur ein Owner kann einen Owner einladen. Das Sitzplatzlimit und die täglichen Einladungslimits gelten.
dataroom_team_change_member_role
Ändert die Rolle eines aktiven Mitglieds. Zwei Schritte; die Vorschau zeigt die alte und die neue Rolle.
- Scope:
admin. - Eingaben:
membership_id,role(erforderlich);confirm_token. - Ausgabe:
{ success: true, membership_id, old_role, role }. - Nur ein Owner kann die Rolle eines Owners ändern oder jemanden zum Owner befördern. Sie können Ihre eigene Rolle nicht ändern, und der letzte Owner kann nicht herabgestuft werden.
dataroom_team_remove_member
Entfernt ein Mitglied oder widerruft eine ausstehende Einladung. Zwei Schritte; die Vorschau zeigt, wie viele Datei- und Ordnerberechtigungen sowie Freigabe-Links des Mitglieds enden.
- Scope:
admin. - Eingaben:
membership_id(erforderlich);confirm_token. - Ausgabe:
{ success: true, membership_id, action, file_grants_ended?, folder_grants_ended?, share_links_deactivated? }. - Das Entfernen beendet seine Berechtigungen in dieser Organisation und deaktiviert die von ihm erstellten Freigabe-Links; Verweigerungen bleiben bestehen. Nur ein Owner kann einen Owner entfernen.
dataroom_team_resend_invite
Sendet eine ausstehende Einladung erneut mit einem neuen Link; der alte Link funktioniert nicht mehr. Zwei Schritte; die Bestätigung versendet die Einladungs-E-Mail.
- Scope:
admin, plus die Berechtigung An Personen außerhalb Ihrer Organisation senden. - Eingaben:
membership_id(erforderlich);confirm_token. - Ausgabe: die Vorschau (
membership_id,email,role) beim ersten Aufruf;{ success: true, membership_id }nach der Bestätigung. - Nur eine ausstehende Einladung kann erneut gesendet werden: Jede andere Mitgliedschaft wird bereits bei der Vorschau abgewiesen, ohne Token. Die täglichen Einladungslimits werden bei der Bestätigung angerechnet.
Tools für Investoren und NDAs
Tools für Ihre Investorenliste, das NDA Ihrer Organisation und die NDAs Ihrer Investorenfirmen. Jedes prüft bei jedem Aufruf die aktuelle Rolle des Token-Inhabers in Ihrer Organisation, sodass eine inzwischen herabgestufte Person oder ein Token, das unter der vom Tool benötigten Rolle begrenzt ist, abgewiesen wird.
Tools, die über die gesamte Organisation lesen, benötigen ein Token, das nicht auf bestimmte Datenräume beschränkt ist. Die Investorenliste enthält Engagement-Daten (wann jemand den Raum zuletzt geöffnet hat, wie viele Einladungs-E-Mails versendet wurden, wann die Einladung angenommen wurde) nur für ein Token, das mit aktivierter Option Engagement-Analysen lesen erstellt wurde. Sie enthält nie Links zu NDA-Verzichten oder Benutzer-IDs.
Einen Investor einladen, seinen Zugriff entfernen oder wiederherstellen, seine
Berechtigungen ändern sowie ein Firmen-NDA anhängen oder widerrufen erfolgt
jeweils in zwei Schritten. Der erste Aufruf ändert nichts: Er liefert eine
Vorschau dessen, was genau geschehen wird, und ein confirm_token. Ihr Assistent
zeigt Ihnen die Vorschau und wiederholt den Aufruf erst nach Ihrer Zustimmung mit
identischen Argumenten plus diesem confirm_token. Ein Token funktioniert einmal
und läuft nach wenigen Minuten ab. Hat sich zwischenzeitlich etwas geändert, das
die Vorschau gezeigt hat, wird der zweite Aufruf abgewiesen, und Ihr Assistent
fragt erneut.
dataroom_list_investors
Listet die Investoren auf, die in Ihre Organisation oder in einen Datenraum eingeladen wurden.
- Scope:
read. Rolle: Owner oder Admin. - Eingaben:
dataroom_id(optional; erforderlich bei einem Token, das auf bestimmte Datenräume beschränkt ist);status(optional:pending,accepted,revokedoderaccess_requested). - Ausgabe:
{ investors: [{ id, email, display_name, role, status, require_nda, nda, investor_org, can_view_monitoring, can_view_updates, expires_at, invited_at }] }. Dieidist die Einladungs-ID, die andere Investoren-Tools erwarten. Mit Engagement-Analysen lesen enthält jede Zeile zusätzlichengagement: { last_seen_at, send_count, last_sent_at, accepted_at }.
dataroom_get_nda
Liest das NDA Ihrer Organisation: Titel, Text und Klauseln der aktuellen Version
sowie die Versionshistorie. Gibt current: null zurück, wenn die Organisation
noch kein NDA hat; das Lesen legt nie eines an.
- Scope:
read. Rolle: ein Mitglied des Deal-Teams. - Eingaben: keine.
- Ausgabe:
{ current, versions, clauses, tally }.tally(Anzahl unterzeichnet, verzichtet und ausstehend) istnullbei einem Token, das auf bestimmte Datenräume beschränkt ist.
dataroom_list_firm_ndas
Listet die Investorenfirmen Ihrer Organisation auf und gibt an, ob jede ein gültiges Firmen-NDA hat.
- Scope:
read. Rolle: ein Mitglied des Deal-Teams. Benötigt ein Token, das nicht auf bestimmte Datenräume beschränkt ist. - Eingaben: keine.
- Ausgabe:
{ firms: [{ id, name, has_live_nda }] }.
dataroom_get_firm_nda
Liest das NDA einer Firma mit Ihrer Organisation sowie die abgeschlossenen E-Signatur-Umschläge (Envelopes), die Sie als deren NDA anhängen könnten.
- Scope:
read. Rolle: ein Mitglied des Deal-Teams. Benötigt ein Token, das nicht auf bestimmte Datenräume beschränkt ist. - Eingaben:
investor_org_id(erforderlich). - Ausgabe:
{ agreement, attachable_envelopes }.agreementistnull, wenn die Firma keines hat.
dataroom_extend_investor_access
Verlängert den Zugriff einer angenommenen Einladung um die Ablaufzeit für Gast-Links Ihrer Organisation (7 Tage, sofern Sie sie nicht geändert haben), und hält die aktuelle Sitzung des Investors ebenso lange aktiv. Nur für eine Einladung in einen Datenraum.
- Scope:
write. Rolle: ein Mitglied des Deal-Teams. Benötigt: An Personen außerhalb Ihrer Organisation senden. - Eingaben:
invite_id(erforderlich). - Ausgabe:
{ invite_id, expires_at, expiry_hours }. Eine nicht angenommene Einladung wird mit einem Konflikt abgewiesen.
dataroom_invite_investor
Lädt einen Investor per E-Mail in einen Datenraum ein, lädt ihn mit einer neuen
Rolle oder NDA-Anforderung erneut ein oder sendet seine Einladung erneut. Er
erhält eine E-Mail mit einem persönlichen Link, sofern notify nicht false
ist. Die Vorschau gibt an, ob die Einladung dadurch erstellt, aktualisiert oder
beibehalten wird, welche Ihrer Argumente ignoriert werden (ein erneuter Versand
behält die gespeicherte Rolle und das NDA bei), die Statusänderung (ein
entfernter Investor wird wiederhergestellt), einen etwaigen NDA-Verzicht und ob
eine E-Mail versendet wird. Die Vorschau verbraucht nichts vom täglichen
Einladungslimit; der Versand schon.
- Scope:
admin. Rolle: Owner oder Admin im Deal-Team des Datenraums. Benötigt: An Personen außerhalb Ihrer Organisation senden. - Eingaben:
email,dataroom_id(erforderlich);role(vieweroderdownloader);require_nda;resend;notify;confirm_token. - Ausgabe: die Vorschau und
confirm_tokenbeim ersten Aufruf; danach{ status: 'sent' | 'added', invite_id, link_expires_at }.
dataroom_revoke_investor_access
Entfernt den Zugriff eines Investors. Seine aktuelle Sitzung sowie seine Datei- und Ordnerberechtigungen im Datenraum der Einladung enden. Eine spätere Wiederherstellung stellt den Raumzugriff wieder her, nicht die Dateiberechtigungen.
- Scope:
admin. Rolle: Owner oder Admin. - Eingaben:
invite_id(erforderlich);confirm_token. - Ausgabe: die Vorschau und
confirm_token; danach{ status: 'revoked', invite_id }.
dataroom_reinstate_investor_access
Stellt einen entfernten Investor wieder her oder genehmigt eine Zugriffsanfrage. Nur Raumzugriff.
- Scope:
admin. Rolle: Owner oder Admin. Benötigt: An Personen außerhalb Ihrer Organisation senden. - Eingaben:
invite_id(erforderlich);confirm_token. - Ausgabe: die Vorschau und
confirm_token; danach{ status: 'reinstated', invite_id }.
dataroom_set_investor_permissions
Ändert die Rolle einer Einladung, die NDA-Anforderung sowie den Zugriff auf Monitoring und Updates. Die Vorschau listet jede Änderung auf. Das Deaktivieren des NDA erfasst einen Verzicht in Ihrem Namen, mit optionaler Begründung und optionalem Link.
- Scope:
admin. Rolle: Owner oder Admin. - Eingaben:
invite_id(erforderlich); mindestens eines vonrole,require_nda,can_view_monitoring,can_view_updates;nda_waiver_reason;nda_waiver_url;confirm_token. - Ausgabe: die Vorschau und
confirm_token; danach{ status: 'updated', invite_id, changes }.
dataroom_attach_firm_nda
Erfasst einen abgeschlossenen E-Signatur-Umschlag als unterzeichnetes NDA einer Investorenfirma, mit Datum der Unterzeichnung und Laufzeit. Jeder Umschlag, den Sie sehen können, kann angehängt werden.
- Scope:
admin. Rolle: Owner oder Admin. Benötigt ein Token, das nicht auf bestimmte Datenräume beschränkt ist. - Eingaben:
investor_org_id,envelope_id,executed_at,term(erforderlich);confirm_token. - Ausgabe: die Vorschau und
confirm_token; danach{ status: 'attached', agreement }.
dataroom_revoke_firm_nda
Widerruft das NDA einer Investorenfirma. Bei einem auf Waafir begonnenen NDA, das noch zur Unterzeichnung aussteht, wird auch der Umschlag storniert.
- Scope:
admin. Rolle: Owner oder Admin. Benötigt ein Token, das nicht auf bestimmte Datenräume beschränkt ist. - Eingaben:
investor_org_id(erforderlich);reason;confirm_token. - Ausgabe: die Vorschau und
confirm_token; danach{ status: 'revoked', investor_org_id, envelope_voided }.
Tools für Investorenfirmen
Tools für Ihre Investorenfirmen: die Gruppen, denen Ihre Investoren angehören, wie auf der Seite „Investoren“. Jedes benötigt eine Owner- oder Admin-Rolle in Ihrer Organisation, die bei jedem Aufruf geprüft wird, und ein Token, das nicht auf bestimmte Datenräume beschränkt ist. Eine unbekannte Firma, die Firma einer anderen Organisation und eine durch Zusammenführung aufgelöste Firma erhalten alle dieselbe „nicht gefunden“-Antwort.
Jemanden einer Firma zuordnen und zwei Firmen zusammenführen erfolgt jeweils in zwei Schritten, wie bei den Investoren-Tools oben. Beides kann eine Person aus ihrer aktuellen Firma herauslösen. Hat die Firma, der sie beitritt, ein unterzeichnetes NDA, deckt es sie ab diesem Zeitpunkt ab, und ihre ausstehenden Einladungen, die ein NDA verlangen, verlangen keines mehr. Führt die Vorschau eine solche Einladung auf, benötigt das Token außerdem An Personen außerhalb Ihrer Organisation senden. Jemanden aus einer Firma zu entfernen ist hier nicht möglich.
dataroom_list_investor_firms
Listet die Investorenfirmen Ihrer Organisation mit ihrer Domain, der Mitgliederzahl, der privaten Notiz des Deal-Teams und dem NDA-Status der Firma auf.
- Scope:
read. Rolle: Owner oder Admin. - Eingaben: keine.
- Ausgabe:
{ investor_firms: [{ id, name, canonical_domain, member_count, deal_team_note, firm_nda }] }.deal_team_noteist als Text gekennzeichnet, den ein Kollege geschrieben hat.
dataroom_create_investor_firm
Erstellt eine Investorenfirma. Mit member_emails und canonical_domain wird
jede aufgeführte Person dieser Domain, die bereits in einen Ihrer Datenräume
eingeladen ist und noch keiner Firma angehört, Mitglied. Niemand wird aus einer
anderen Firma herausgelöst.
- Scope:
admin. Rolle: Owner oder Admin. - Eingaben:
name(erforderlich);canonical_domain;member_emails(bis zu 500, benötigtcanonical_domain). - Ausgabe:
{ status: 'created', investor_firm: { id, name }, added }.
dataroom_rename_investor_firm
Benennt eine Investorenfirma um.
- Scope:
admin. Rolle: Owner oder Admin. - Eingaben:
investor_org_id,name(erforderlich). - Ausgabe:
{ status: 'renamed' | 'unchanged', investor_org_id, name }.
dataroom_set_investor_firm_note
Setzt oder löscht die private Notiz des Deal-Teams zu einer Firma. Investoren sehen sie nie.
- Scope:
admin. Rolle: Owner oder Admin. - Eingaben:
investor_org_id,note(erforderlich; eine leere Zeichenkette löscht sie). - Ausgabe:
{ status: 'set' | 'cleared' | 'unchanged', investor_org_id, cleared }.
dataroom_assign_investor_to_firm
Ordnet einen Investor per E-Mail einer Firma zu und löst ihn gegebenenfalls aus seiner aktuellen Firma heraus. Die Vorschau nennt die Firma, die er verlässt, und die ausstehenden Einladungen, deren NDA-Schritt das NDA der Firma nun erfüllen würde. Wer bereits in der Firma ist, bleibt unverändert, ohne Bestätigungsschritt.
- Scope:
admin. Rolle: Owner oder Admin. Benötigt: An Personen außerhalb Ihrer Organisation senden, wenn die Vorschau eine Einladung aufführt. - Eingaben:
investor_org_id,email(erforderlich);confirm_token. - Ausgabe: die Vorschau und
confirm_token; danach{ status: 'assigned', investor_org_id, email, moved_from, coverage_started }.
dataroom_merge_investor_firms
Führt eine Firma mit einer anderen zusammen. Jedes Mitglied der Quellfirma wechselt zur Zielfirma, und die Quellfirma verschwindet aus Ihrer Firmenliste. Eine Zusammenführung können Sie weder über Ihren Assistenten noch in der App rückgängig machen. Die Vorschau listet die wechselnden Personen und die ausstehenden Einladungen auf, deren NDA-Schritt das NDA der Zielfirma nun erfüllen würde.
- Scope:
admin. Rolle: Owner oder Admin. Benötigt: An Personen außerhalb Ihrer Organisation senden, wenn die Vorschau eine Einladung aufführt. - Eingaben:
source_investor_org_id,target_investor_org_id(erforderlich und verschieden);confirm_token. - Ausgabe: die Vorschau und
confirm_token; danach{ status: 'merged', source_investor_org_id, target_investor_org_id, moved_count, coverage_started_count }.
Engagement-Tools
Nur lesende Tools dazu, wer was wann und wie lange gelesen hat. Dies sind
Verhaltensdaten über namentlich bekannte Personen, daher benötigt jedes dieser
Tools ein Token, das mit aktivierter Option Engagement-Analysen lesen erstellt
wurde, sowie eine Deal-Team-Rolle. Jedes zählt nur Dokumente, die der
Token-Inhaber selbst lesen kann. Die Raum-Tools nehmen denselben Filter wie die
Engagement-Seite entgegen: range (oder from und to), people,
firm_ids, folder_id und tz.
dataroom_get_activity_trail
Das Zugriffsprotokoll Ihrer Organisation, neueste Einträge zuerst. Benötigt ein Token, das nicht auf bestimmte Datenräume beschränkt ist.
- Scope:
read. Eingaben:counterparty,since,cursor,limit.
dataroom_get_room_engagement
Scoreboard, Heatmap und Zeitachse eines Datenraums, mit den Deal-Zusammenfassungen.
- Scope:
read. Eingaben:dataroom_id(erforderlich) und der Filter.
dataroom_get_engagement_scores
Der Engagement-Score jedes Investors in einem Datenraum, als Rangliste.
- Scope:
read. Eingaben:dataroom_id(erforderlich) und der Filter.
dataroom_get_investor_engagement
Die Besuche und geöffneten Dokumente eines Investors in einem Datenraum. Der Abruf wird in Ihrem Audit-Log erfasst, wie in Waafir.
- Scope:
read. Eingaben:dataroom_id,email(erforderlich) und der Filter.
dataroom_get_document_engagement
Lesen pro Dokument nach Gegenpartei in Ihrer gesamten Organisation und mit
file_id die Verweildauer pro Seite für dieses Dokument. Benötigt ein Token, das nicht auf bestimmte Datenräume beschränkt ist.
- Scope:
read. Eingaben:counterparty,file_id,weeks,cursor,limit,page_range.
dataroom_get_firm_rollups
Wöchentliche Aktivität pro Gegenpartei in Ihrer gesamten Organisation. Benötigt ein Token, das nicht auf bestimmte Datenräume beschränkt ist.
- Scope:
read. Eingaben:counterparty,weeks,cursor,limit.
Q&A-Tools
Zwei schreibgeschützte Tools für die Q&A-Threads der Investoren in einem Datenraum. Ein
Deal-Team-Token kann hier keine Frage stellen; der eigene Agent eines Investors fragt mit
dataroom_ask_question (siehe Tools für Investoren-Agenten).
Was ein Aufruf zurückgibt, hängt davon ab, wem das Token gehört:
- ein Mitglied des Deal-Teams sieht jeden Thread im Datenraum, einschließlich der E-Mail-Adresse des Fragenden;
- ein Investor sieht nur die Fragen, die er selbst gestellt hat, und überhaupt keine E-Mail-Adressen.
Angehängte Dokumente werden nur mit ID und Name zurückgegeben – nie mit Inhalt, nie mit Download-Link –, und der Name eines Dokuments, das der Aufrufer nicht sehen darf, wird zurückgehalten. Verwenden Sie für Inhalte die Dokument-Tools; diese wenden ihre eigenen Zugriffsprüfungen an. Organisationsweite Company-Q&A-Fragen, die keinem Datenraum zugeordnet sind, werden von keinem der beiden Tools zurückgegeben.
dataroom_list_questions
Name am Bereichs-Endpunkt: list_questions
Listet die Q&A-Threads in einem autorisierten Datenraum auf, die neuesten zuerst, jeweils mit ihren Antworten.
- Scope:
read. - Eingaben:
dataroom_id(erforderlich);status(optional –open,answeredoderclosed);file_id(optional – nur Fragen zu diesem Dokument);limit(optional, 1–100, Standard 25);offset(optional, Standard 0). - Ausgabe:
{ questions, pagination }. Blättern Sie mitoffset, solangepagination.has_moreden Werttruehat.
dataroom_get_question
Name am Bereichs-Endpunkt: get_question
Ruft einen Q&A-Thread anhand seiner ID mit allen Antworten ab.
- Scope:
read. - Eingaben:
dataroom_id(erforderlich);question_id(erforderlich). - Ausgabe:
{ question }. - Eine Frage in einem anderen Datenraum oder einer anderen Organisation – oder, für einen
Investor, eine von jemand anderem gestellte – meldet
NOT_FOUND. Das Tool bestätigt nie, dass eine solche ID existiert.
Jede Frage enthält { id, dataroom_id, title, body, question_type, status, asked_by, file_id, file_name, created_at, updated_at, responses } sowie
asker_email nur, wenn der Aufrufer dazu berechtigt ist – für einen Investor fehlt der
Schlüssel in der Nutzlast, statt vorhanden und null zu sein. Jeder Eintrag in
responses ist { id, body, responded_by, is_ai_draft, created_at, updated_at, attachments }.
dataroom_answer_question (Schreiben)
Beantwortet die Frage eines Investors. Es gibt keinen Entwurf: Der Investor sieht die Antwort sofort, und der Fragende wird per E-Mail benachrichtigt, sofern seine Einstellungen dies zulassen. Beides lässt sich nicht zurücknehmen.
- Scope:
write. Deal-Team-Mitglieder des Datenraums. - Berechtigung: Das Token benötigt An Personen außerhalb Ihrer Organisation senden.
- Eingaben:
dataroom_id,question_id,body(alle erforderlich);confirm_token. - Zwei Schritte. Ohne
confirm_tokenwird nichts veröffentlicht, und Sie erhalten eine Vorschau (die Frage, wie viele Antworten sie hat, ob der Fragende per E-Mail benachrichtigt wird) sowie ein Token. Rufen Sie das Tool erneut mit denselben Argumenten und dem Token auf, um zu veröffentlichen. Kommt in der Zwischenzeit eine neue Antwort hinzu oder wird der Thread geschlossen, schlägt der Aufruf fehl, und Sie rufen erneut die Vorschau ab.
dataroom_close_question (Schreiben)
Schließt einen Q&A-Thread. Sein Fragender oder ein Admin oder Manager der Organisation darf ihn schließen.
- Scope:
write. - Eingaben:
dataroom_id,question_id(beide erforderlich). - Ausgabe:
{ question_id, outcome, kb_draft, kb_draft_skip_reason }. - Wenn die Organisation für KI bezahlt und sie aktiviert hat, wird beim Schließen eines Threads mit Antworten
zusätzlich ein Wissensdatenbank-Entwurf in die Warteschlange gestellt. Andernfalls ist
kb_draftskipped, und der Grund wird angegeben. An den Investor wird nichts gesendet.
dataroom_bulk_close_questions (Schreiben)
Schließt bis zu 100 Threads eines Datenraums. Jeder wird einzeln beurteilt.
- Scope:
write. - Eingaben:
dataroom_id,question_ids(beide erforderlich). - Ausgabe:
{ requested, closed, results }. Dasoutcomejedes Ergebnisses istclosed,not_found,forbiddenoderalready_closed.
dataroom_edit_question (Schreiben)
Bearbeitet Titel und/oder Text einer Frage. Nur Admins und Manager.
- Scope:
write. - Eingaben:
dataroom_id,question_id(beide erforderlich);title,body(mindestens eines davon). - Ausgabe:
{ question_id, title, body }.
dataroom_edit_answer (Schreiben)
Bearbeitet den Text einer Antwort. Nur Admins und Manager. Der Investor sieht die Änderung sofort, wie in Waafir; es wird keine neue E-Mail gesendet.
- Scope:
write. - Eingaben:
dataroom_id,question_id,response_id,body(alle erforderlich). - Ausgabe:
{ response_id, question_id, body }.
dataroom_delete_question (Schreiben)
Löscht einen Q&A-Thread. Investoren sehen ihn und seine Antworten nicht mehr. Nur Admins und Manager.
- Scope:
write. - Eingaben:
dataroom_id,question_id(beide erforderlich);confirm_token. - Zwei Schritte. Ohne
confirm_tokenwird nichts gelöscht, und Sie erhalten eine Vorschau sowie ein Token. Rufen Sie das Tool erneut mit denselben Argumenten und dem Token auf, um zu löschen. Ein Token funktioniert einmal und läuft nach wenigen Minuten ab.
dataroom_delete_answer (Schreiben)
Löscht eine Antwort in einem Thread. Der Investor sieht sie nicht mehr. Nur Admins und Manager.
- Scope:
write. - Eingaben:
dataroom_id,question_id,response_id(alle erforderlich);confirm_token. - Zwei Schritte, wie bei
dataroom_delete_question.
dataroom_publish_kb_article (Schreiben)
Veröffentlicht einen Wissensdatenbank-Artikel, zum Beispiel einen aus einem geschlossenen Thread erstellten Entwurf. Investoren, die den Datenraum sehen können, können ihn dann lesen. Nur Admins und Manager.
- Scope:
write. - Eingaben:
dataroom_id,article_id(beide erforderlich);confirm_token. - Zwei Schritte, wie bei
dataroom_delete_question.
Tools für Investor-Updates
Diese spiegeln den Editor für Investor-Updates in Waafir, mit denselben Rollenprüfungen. Jedes benötigt das Add-on Investor-Materialien für den Datenraum. Keines davon sendet etwas an Investoren: Veröffentlicht wird in Waafir.
dataroom_list_updates
Listet die Investor-Updates eines Datenraums in jedem Status auf, die zuletzt geänderten zuerst.
- Scope:
read. Deal-Team-Mitglieder des Datenraums. - Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ updates }, jeweils{ id, title, period_label, status, version, published_at, updated_at }.
dataroom_create_update (Schreiben)
Erstellt einen Update-Entwurf aus Portfolios und/oder Dateien (mindestens eines davon).
- Scope:
write. Deal-Team-Mitglieder des Datenraums. - Eingaben:
dataroom_id,period_label(beide erforderlich);title,period_start,period_end,tone_notes,portfolio_ids,file_ids. - Ausgabe:
{ update_id, status, portfolio_count, file_count }. Dateien und Portfolios, die nicht zu Ihrer Organisation gehören, werden ausgelassen und nicht gezählt.
dataroom_get_update
Liest ein Update so, wie der Editor es anzeigt.
- Scope:
read. Eigentümer und Admins. - Eingaben:
dataroom_id,update_id(beide erforderlich). - Ausgabe:
{ update_id, status, document, latest_generation }.documentist der zuletzt generierte Entwurf mit Ihren Änderungen, oder null vor der ersten Generierung.
dataroom_get_update_generation
Der Status eines Generierungslaufs.
- Scope:
read. Eigentümer und Admins. - Eingaben:
dataroom_id,update_id,generation_id(alle erforderlich). - Ausgabe:
{ generation_id, status, error_code }. Ein fehlgeschlagener Lauf liefert seinen Code, nie die gespeicherte Meldung.
dataroom_generate_update (Schreiben)
Startet eine KI-Generierung für ein Update im Entwurf oder in Prüfung.
- Scope:
write, dazu Dokumentinhalt lesen für das Token: Der Lauf liest die ausgewählten Dateien vollständig, gesteuert durch die Tonhinweise des Updates. Eigentümer und Admins. - Eingaben:
dataroom_id,update_id(beide erforderlich). - Ausgabe:
{ generation_id, queued }. Fragen Siedataroom_get_update_generationregelmäßig ab. - Erfordert einen kostenpflichtigen Plan und aktivierte KI-Funktionen und wird auf das tägliche KI-Limit angerechnet. Es teilt sich das Limit des Editors von 5 Generierungen pro Minute.
dataroom_edit_update_draft (Schreiben)
Speichert Ihre Änderungen über dem generierten Inhalt eines Entwurfs, wie es der Editor tut.
- Scope:
write. Eigentümer und Admins. - Eingaben:
dataroom_id,update_id,overrides(alle erforderlich).overridesnimmtnarrative_sections,chart_placementsundcitationsan. - Ausgabe:
{ update_id, status, document }. Nur ein Entwurf kann bearbeitet werden.
dataroom_submit_update_for_review (Schreiben)
Setzt einen Update-Entwurf auf in_review.
- Scope:
write. Admins und Manager. - Eingaben:
dataroom_id,update_id(beide erforderlich). - Ausgabe:
{ update_id, status }. - Das Update benötigt generierten Inhalt, und es darf keine Generierung laufen.
dataroom_publish_update (Schreiben)
Veröffentlicht ein Update, das sich in Prüfung befindet. Die Investoren des Datenraums können es sofort sehen, und jeder wird per E-Mail benachrichtigt, was sich nicht zurücknehmen lässt.
- Scope:
write. Admins und Manager. - Berechtigung: Das Token benötigt An Personen außerhalb Ihrer Organisation senden.
- Eingaben:
dataroom_id,update_id(beide erforderlich);confirm_token. - Zwei Schritte. Ohne
confirm_tokenwird nichts veröffentlicht, und Sie erhalten eine Vorschau (das Update und wie viele Investoren per E-Mail benachrichtigt werden) sowie ein Token. Rufen Sie das Tool erneut mit denselben Argumenten und dem Token auf, um zu veröffentlichen. Haben sich das Update oder seine Investorenliste in der Zwischenzeit geändert, wird der Aufruf abgelehnt, und Sie rufen erneut die Vorschau ab.
dataroom_republish_update (Schreiben)
Kopiert ein veröffentlichtes Update in eine neue Entwurfsversion, die Sie dann bearbeiten, prüfen und veröffentlichen. Die veröffentlichte Version bleibt bis dahin live.
- Scope:
write. Admins und Manager. - Eingaben:
dataroom_id,update_id(beide erforderlich). - Ausgabe:
{ update_id, status, version }des neuen Entwurfs.
Marktintelligenz-Tools
Schreibgeschützt. Sie benötigen das Add-on Marktintelligenz (eine Vorschau funktioniert, mit ihren Einschränkungen), ein Token, das nicht auf bestimmte Datenräume beschränkt ist, und ein Deal-Team-Mitglied als dessen Eigentümer.
mi_get_subject
Das Market-Intelligence-Unternehmen Ihrer Organisation.
- Scope:
read. - Eingaben: keine.
- Ausgabe:
{ subject, access }.subjectist{ id, name }oder null, bis jemand Marktintelligenz in Waafir geöffnet hat.
mi_get_profile
Das Profil eines Unternehmens: die bestätigte Version und der Arbeitsentwurf.
- Scope:
read. - Eingaben:
subject_id(erforderlich). - Ausgabe:
{ subject, confirmed, draft, file_names }. Jedes Feld iststated(mit derfile_idund derpage, aus der es gelesen wurde, oder einer öffentlichen Webseite und ihrem Zitat),entered,not_applicableoder null. - Zitate aus Datenraum-Dokumenten werden nicht zurückgegeben. Lesen Sie die Datei mit den Dokument-Tools, wenn Sie sie benötigen.
mi_list_matches
Die für das Profil des Unternehmens gerankten Investoren, die besten zuerst.
- Scope:
read. - Eingaben:
subject_id(erforderlich). - Ausgabe:
{ profile_version, preliminary, similarity, live, country, caveat, total, matches }. Jeder Treffer ist{ entity_id, name, score, penalties, reasons, contacts_available, on_roster, addable }. - Eine Vorschau zeigt die Top 3. Das Ähnlichkeitsranking wird nur verwendet, wenn Ihr Plan
KI bezahlt, KI aktiviert ist und das tägliche KI-Limit es zulässt;
similaritygibt an, welches verwendet wurde. - Kontaktdaten werden nie zurückgegeben. Es teilt sich das Limit der Waafir-Seite von 30 pro Minute.
KI-Tools
Diese Tools erledigen die KI-Arbeit auf der Seite von Waafir und übergeben Ihrem KI-Client das Ergebnis: eine Antwort mit Quellenangaben, eine Zusammenfassung, eine Prüfung, einen vorgeschlagenen Ordnerplan oder einen Entwurf. Ihr Client muss dafür nie die Dokumente herunterladen. Sie benötigen das KI-Add-on, werden auf das tägliche KI-Budget Ihrer Organisation angerechnet und pausieren, wenn Ihre Administratoren die KI pausieren. Jedes ist pro Person auf dieselbe Rate begrenzt wie die entsprechende Schaltfläche in der App und protokolliert, was es zurückgegeben hat, im Aktivitätsprotokoll.
Eine Antwort kann wiedergeben, was in einem Dokument steht, wenn Ihr Client die
Frage formuliert; daher benötigen dataroom_ask, dataroom_draft_answer und
dataroom_compare_files die Berechtigung Dokumentinhalt lesen für das Token, wie
dataroom_get_file_text. Ohne sie werden sie nicht aufgelistet, und ein Aufruf wird
mit GRANT_REQUIRED abgelehnt. Die übrigen KI-Tools führen eine feste Aufgabe über den
Raum aus und funktionieren ohne sie. Jedes Ergebnis kennzeichnet die Felder mit KI-Ausgabe in
untrusted_content (siehe Nicht vertrauenswürdiger Text in Ergebnissen).
Es werden immer nur Dokumente verwendet oder zitiert, die der Eigentümer des Tokens öffnen kann. Die Tools funktionieren in Datenräumen der eigenen Organisation des Tokens.
dataroom_ask
Stellt eine Frage zu einem Datenraum und liefert eine fundierte Antwort.
- Scope:
read, dazu Dokumentinhalt lesen für das Token. Jedes Mitglied des Datenraums. - Eingaben:
dataroom_id(erforderlich);question(erforderlich). - Ausgabe:
{ dataroom_id, answer, citations }. Bis zu 10 Quellenangaben, jeweils{ source_type, id, title, page? }. Es wird kein Dokumenttext zurückgegeben, und es wird kein Chatverlauf gespeichert.
dataroom_summarise_file
Ruft die KI-Zusammenfassung und die wichtigsten Punkte einer Datei ab.
- Scope:
read. Deal-Team, mit Download-Zugriff auf die Datei. - Eingaben:
dataroom_id(erforderlich);file_id(erforderlich). - Ausgabe:
{ file_id, file_name, status: "ready", summary, key_points }oderstatus: "queued", wenn die Datei noch keine Zusammenfassung hat. Die Zusammenfassung startet dann im Hintergrund, wie mit der Schaltfläche „Summarise" (Zusammenfassen); rufen Sie das Tool später erneut auf.
dataroom_list_facts
Listet die verifizierten Fakten und Schlüsselbegriffe auf, die aus den Dokumenten eines Datenraums extrahiert wurden.
- Scope:
read. Deal-Team. - Eingaben:
dataroom_id(erforderlich);file_id(optional);types(optional);limit(optional, 1–200, Standard 50);cursor(optional). - Ausgabe:
{ dataroom_id, facts, has_more, next_cursor }. Jeder Fakt ist{ id, file_id, file_name, fact_type, value, page, confidence, created_at }. Solangehas_moreden Werttruehat, übergeben Sienext_cursoralscursorfür die nächste Seite. - Ohne Dokumentinhalt lesen für das Token behält der
valuejedes Fakts höchstens 20 Wörter (160 Zeichen), gezählt über den gesamten Wert, und der Fakt enthältvalue_truncated.
dataroom_compare_files
Vergleicht zwei Dateien in einem Datenraum und liefert die wesentlichen Unterschiede.
- Scope:
read, dazu Dokumentinhalt lesen für das Token. Deal-Team, mit Download-Zugriff auf beide Dateien. - Eingaben:
dataroom_id(erforderlich);file_id_a(erforderlich);file_id_b(erforderlich). - Ausgabe:
{ dataroom_id, file_a, file_b, differences }. Jeder Dateieintrag ist{ id, name, truncated }: Ein sehr langes Dokument wird anhand seines ersten Teils verglichen, undtruncatedzeigt dies an. Es wird kein Dokumenttext zurückgegeben. - Eine Datei eines Typs ohne extrahierbaren Text wird mit
400abgelehnt, und eine gespeicherte Datei über 50 MB mit413(FILE_TOO_LARGE), bevor eine der beiden abgerufen wird, sofern der Text der Datei nicht bereits extrahiert wurde.
dataroom_review
Führt die KI-Readiness-Prüfung eines Datenraums aus.
- Scope:
read. Deal-Team. - Eingaben:
dataroom_id(erforderlich);force_refresh(optional). - Ausgabe:
{ dataroom_id, cached, readinessScore, presentDocs, missingDocs, flaggedForRedaction, flaggedForRename, flaggedOutOfDate, suggestions }. Eine aktuelle gespeicherte Prüfung wird ohne neuen KI-Lauf zurückgegeben, es sei denn,force_refreshisttrue.
dataroom_propose_organise (Schreiben)
Schritt 1 von 2: Schlägt eine Ordnerstruktur für einen Datenraum vor. Nichts wird verschoben.
- Scope:
write. Eigentümer oder Admin. - Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ dataroom_id, suggestion_id, applied: false, proposed_folders, unchanged_file_ids, files, total_files, accounted_for }.
dataroom_apply_organise (Schreiben)
Schritt 2 von 2: Wendet einen Vorschlag anhand seiner suggestion_id an. Es wird genau der gespeicherte
Vorschlag angewendet, einmal; er kann unterwegs nicht bearbeitet werden. Dateien, die der Eigentümer des
Tokens nicht verschieben darf, werden übersprungen und gezählt. Zum Rückgängigmachen verwenden Sie den Bereich „Organise" (Organisieren) in
der App.
- Scope:
write. Eigentümer oder Admin. - Eingaben:
dataroom_id(erforderlich);suggestion_id(erforderlich). - Ausgabe:
{ dataroom_id, suggestion_id, folders_created, files_moved, files_skipped }.
dataroom_draft_answer
Entwirft aus den Dokumenten des Datenraums eine Antwort auf eine Investorenfrage.
- Scope:
read, dazu Dokumentinhalt lesen für das Token. Eigentümer oder Admin. - Eingaben:
question_id(erforderlich). - Ausgabe:
{ question_id, draft, is_draft: true, sources }. Der Entwurf wird nur an Sie zurückgegeben: Nichts wird gespeichert, gesendet oder veröffentlicht. Eine Person veröffentlicht die Antwort in der App. Fragen auf Organisationsebene werden in der App entworfen.
Tools für Readiness und Wissensdatenbank
Schreibgeschützt. Readiness liefert den Score und die zugrunde liegenden Zählwerte, nie den
Text der Prüfung; führen Sie dafür dataroom_review aus.
dataroom_get_readiness_score
Der Readiness-Score eines Datenraums.
- Scope:
read, und der Eigentümer des Tokens muss Eigentümer oder Admin der Organisation sein. - Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ dataroom_id, score, reviewed, questions_total, questions_answered, kb_articles, files_uploaded, present_categories, missing_categories }.scoreliegt zwischen 0 und 100 oder istnull, wenn es keine KI-Prüfung gibt, die Ihnen angezeigt werden darf.
dataroom_get_readiness_rollup
Readiness über die Datenräume der Organisation hinweg, wie das Dashboard sie anzeigt.
- Scope:
read, und der Eigentümer des Tokens muss zum Deal-Team gehören. Ein Token, das auf bestimmte Datenräume beschränkt ist, wird abgelehnt. - Eingaben: keine.
- Ausgabe:
{ rooms: [{ id, name, investors, reading, updated, status, readinessPct, tone, reviewedAt, presentCount, missingCount, categories }] }. Die Dokumentzahlen je Kategorie umfassen nur Dokumente, die der Eigentümer des Tokens lesen darf.
dataroom_list_kb_articles
Listet die Wissensdatenbank-Artikel eines Raums auf, seine eigenen und die organisationsweiten.
- Scope:
read. - Eingaben:
dataroom_id(erforderlich);category;include_drafts(nur Deal-Team). - Ausgabe:
{ articles: [{ id, title, category, published }] }. - Wer nur über ein freigegebenes Dokument Zugang zum Raum hat, sieht keine Artikel. Ein Investor-Token sieht nur veröffentlichte Artikel.
dataroom_get_kb_article
Liest einen Artikel.
- Scope:
read. - Eingaben:
dataroom_id,article_id(erforderlich). - Ausgabe:
{ id, title, category, body, published, updated_at }. Ein Entwurf gilt als nicht gefunden, es sei denn, der Eigentümer des Tokens gehört zum Deal-Team.
Tools für Investoren-Agenten
Tools für den eigenen Agenten eines Investors: Sie funktionieren nur mit einem Investor-Zugriffstoken, und ein Deal-Team-Token kann sie weder auflisten noch aufrufen.
Ein Investor-Token kann außerdem diese gemeinsamen Tools aufrufen. Jedes antwortet nur mit dem, was der Investor im Datenraum sieht.
- Räume und Dateien:
dataroom_list,dataroom_get,dataroom_list_folders,dataroom_list_files,dataroom_get_file_metadataunddataroom_search. - Snapshots:
dataroom_list_snapshotsunddataroom_get_snapshot, für Snapshots, die der Investor ansieht. - Downloads:
dataroom_get_file_download_url. Die Kopie wird immer mit der Identität des Investors mit einem Wasserzeichen versehen, wie sein Browser-Download. - Q&A und Artikel:
dataroom_list_questions,dataroom_get_question,dataroom_list_kb_articlesunddataroom_get_kb_article. Diese liefern die eigenen Fragen des Investors und veröffentlichte Artikel. - KI:
dataroom_ask,dataroom_compare_files,translate_text,translate_fileundtranslate_file_status. Die Übersetzungen eines Investors sind nur für ihn sichtbar.
Einem Investor-Token wird dataroom_get_file_text verweigert: Reiner Text kann kein
Wasserzeichen tragen, daher verwendet der Agent stattdessen den Download mit Wasserzeichen.
Wer für KI bezahlt. Jeder KI-Aufruf kostet Kontingenteinheiten. Die Organisation des Raums
bezahlt bis zu einem monatlichen Kontingent pro Investor und Raum (UTC-Monate).
Das Deal-Team legt das Kontingent pro Raum fest; der Standardwert ist 200 Einheiten. Jenseits
des Kontingents bezahlt eine Organisation, deren Mitglied der Investor ist, sofern sie ein
aktives Abonnement hat und KI aktiviert ist (zuerst Organisationen, die dem Investor gehören,
dann die älteste). Trifft beides nicht zu, wird der Aufruf vor jeder Modellarbeit mit QUOTA_EXCEEDED (HTTP
402) abgelehnt. Die Meldung nennt das Datum, an dem das Kontingent zurückgesetzt wird.
Ratenlimit. Die Agenten eines Investors teilen sich ein Limit von 60 Aufrufen pro Minute, über alle Tokens und Verbindungen dieses Investors hinweg. Darüber hinaus wird der Aufruf abgelehnt (HTTP 429), mit der Wartezeit bis zum erneuten Versuch.
Jedes Tool prüft, was der Datenraum für den Investor prüft: Zugriff nicht abgelaufen oder widerrufen, NDA akzeptiert, der Agent-Schalter des Deal-Teams für den Raum aktiviert und, bei einer Datei, der Lesezugriff des Investors darauf. Eine Datei, die er nicht lesen kann, wird als nicht gefunden gemeldet, und ihr Name wird nie zurückgegeben. Das Akzeptieren eines NDA erfolgt weiterhin im Datenraum.
dataroom_ask_question (Schreiben)
Stellt dem Deal-Team eine Frage in einem Datenraum. Nur der Investor und das Deal-Team sehen sie; das Deal-Team wird benachrichtigt.
- Scope:
write. - Eingaben:
dataroom_id,title(mindestens 5 Zeichen) (erforderlich);description,category,file_id(eine Datei, die der Investor lesen kann). - Ausgabe:
{ question_id, dataroom_id, file_id, status }.
dataroom_list_file_comments
Die Kommentare, die der Investor zu einer Datei sehen kann: seine eigenen, mit den Antworten.
- Scope:
read. - Eingaben:
dataroom_id,file_id(erforderlich). - Ausgabe:
{ comments: [{ id, content, page, resolved, created_at, author, replies }] }.
dataroom_add_file_comment (Schreiben)
Kommentiert eine Datei, die der Investor lesen kann. Sichtbar für den Investor und das Deal-Team, nie für andere Investoren.
- Scope:
write. - Eingaben:
dataroom_id,file_id,content(erforderlich);page. - Ausgabe:
{ comment_id, file_id, created_at }.
dataroom_reply_file_comment (Schreiben)
Antwortet auf einen Kommentar, den der Investor sehen kann. Ein Kommentar zu einer anderen Datei wird als nicht gefunden gemeldet.
- Scope:
write. - Eingaben:
dataroom_id,file_id,comment_id,content(erforderlich). - Ausgabe:
{ reply_id, comment_id, created_at }.
dataroom_get_my_nda_status
Der NDA-Status des Investors in jedem Raum, den sein Agent erreichen kann.
- Scope:
read. - Eingaben: keine.
- Ausgabe:
{ rooms: [{ dataroom_id, dataroom_name, basis, accepted, accepted_at, version, accept_step }] }.basisistorg_standard,firm_executed,firm_in_progress,waivedodernot_required;accept_stepistclickthrough,heldodernone.
dataroom_list_my_notifications
Die Benachrichtigungen des Investors aus der Organisation des Tokens: Einladungen, Antworten auf seine Fragen und Änderungen an seinem Ordnerzugriff.
- Scope:
read. - Eingaben:
unread_only;limit(1–50, Standard 20);offset. - Ausgabe:
{ notifications: [{ id, type, title, body, resource_type, resource_id, read, created_at }], unread_count, pagination }.
dataroom_mark_notifications_read (Schreiben)
Markiert Benachrichtigungen als gelesen: die aufgeführten IDs oder alle mit all: true.
- Scope:
write. - Eingaben:
ids(1–100) oderall. - Ausgabe:
{ marked }, wie viele geändert wurden.
dataroom_list_published_updates
Die Investor-Updates, die in einem Raum für den Investor veröffentlicht wurden.
- Scope:
read. - Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ updates: [{ id, title, period_label, version, published_at, unread }] }. - Abgelehnt, wenn das Deal-Team Updates für den Investor deaktiviert hat, und wenn der Raum das Add-on Investor-Materialien nicht hat.
dataroom_get_published_update
Liest ein veröffentlichtes Update.
- Scope:
read. - Eingaben:
dataroom_id,update_id(erforderlich). - Ausgabe:
{ update_id, title, period_label, version, published_at, document }.
Snapshot-Tools
Ein Snapshot ist eine eingefrorene Kopie der Ordner und Dateiversionen eines Raums, die für einen
Prüfpfad aufbewahrt wird. Kein Tool liefert Dateiinhalte oder einen Download-Link; Downloads bleiben in
der App.
dataroom_get_snapshot und die Betrachter-Tools lehnen ein Token ab, das auf bestimmte
Datenräume beschränkt ist, wie es ihre App-Routen tun.
dataroom_list_snapshots
- Scope:
read. Das Deal-Team sieht jeden Snapshot; alle anderen sehen nur die, zu denen sie als Betrachter hinzugefügt wurden. - Eingaben:
dataroom_id(erforderlich). - Ausgabe:
{ snapshots: [{ id, name, purpose, snapshot_at, file_count, folder_count, viewer_count? }] }.
dataroom_get_snapshot
- Scope:
readund Zugriff auf den Snapshot. - Eingaben:
snapshot_id(erforderlich). - Ausgabe:
{ snapshot, folders: [{ folder_id, parent_folder_id, name }], files: [{ file_id, folder_id, name, size_bytes, mime_type, can_download }], can_manage_viewers }. Dateien und Ordner, die der Eigentümer des Tokens heute nicht sehen darf, werden ausgelassen, und die Zählwerte entsprechen dem, was aufgelistet ist.
dataroom_create_snapshot
Friert den Raum in seinem aktuellen Zustand ein. Im Raum ändert sich nichts.
- Scope:
write, nur Deal-Team. - Eingaben:
dataroom_id,name(erforderlich);purpose,notes. - Ausgabe:
{ snapshot: { id, name, purpose, snapshot_at, file_count, folder_count, viewer_count } }.
dataroom_list_snapshot_viewers
- Scope:
read, nur Deal-Team. - Eingaben:
snapshot_id(erforderlich). - Ausgabe:
{ viewers: [{ viewer_id, email, granted_at, revoked_at, active }] }.
dataroom_grant_snapshot_viewer
Erlaubt jemandem, einen Snapshot über seine E-Mail-Adresse zu öffnen. Zwei Schritte: Die Vorschau nennt den Snapshot und die Adresse. Es wird keine E-Mail gesendet: Informieren Sie die Person selbst.
- Scope:
write, nur Deal-Team, dazu die Berechtigung An Personen außerhalb Ihrer Organisation senden. - Eingaben:
snapshot_id,email(erforderlich);confirm_token. - Ausgabe:
{ viewer_id, email, active }.
dataroom_revoke_snapshot_viewer
Zwei Schritte.
- Scope:
write, nur Deal-Team. - Eingaben:
snapshot_id,viewer_id(erforderlich);confirm_token. - Ausgabe:
{ success: true, viewer_id }.
Freigabe-Link-Tools
Ein Freigabe-Link verschafft jedem, der ihn besitzt, Zugang zu einem Raum oder einem Dokument; daher erfordert das Erstellen immer zwei Schritte und ein Token mit der Berechtigung An Personen außerhalb Ihrer Organisation senden. Kein Tool listet die URL eines Links auf.
dataroom_list_share_links
- Scope:
read, und der Eigentümer des Tokens muss Eigentümer oder Admin der Organisation sein. - Eingaben:
dataroom_id(erforderlich);file_idfür die aktiven Links eines Dokuments. - Ausgabe:
{ links: [{ id, kind, file_id?, mode, active, expires_at, has_password, require_nda, domain_allow_list, created_at, admitted_count? }] }. - Links pro Investor werden nicht aufgelistet; siehe die Investoren-Tools.
dataroom_create_share_link
Zwei Schritte. Die Vorschau gibt an, was freigegeben wird, wer Zugang erhält, die NDA-Regel, wann der Link abläuft und wie Downloads mit Wasserzeichen versehen werden. Die Bestätigung muss dieselben Argumente wiederholen; ändert sich die Investorenliste in der Zwischenzeit, bestätigen Sie erneut.
- Scope:
write, Eigentümer oder Admin der Organisation, dazu die Berechtigung An Personen außerhalb Ihrer Organisation senden. - Eingaben:
dataroom_id,mode(openoderrestricted) (erforderlich);file_id;expires_in_hours;domain_allow_list;require_nda(Standardtrue);confirm_token. - Ausgabe:
{ id, url, mode, active, expires_at, require_nda, file_id }. - Ein eingeschränktes Dokument kann nicht per Link freigegeben werden. Es gibt keine Passwortoption.
dataroom_revoke_share_link
Zwei Schritte. Alle, die den Link verwenden, verlieren sofort den Zugriff.
- Scope:
write, Eigentümer oder Admin der Organisation. - Eingaben:
dataroom_id,link_id(erforderlich);confirm_token. - Ausgabe:
{ success: true, link_id, status: "revoked" }.