Waafir
Cette page est une traduction automatique en attente de relecture humaine. Elle peut contenir des erreurs.

Référence de waafir-dataroom

Le serveur waafir-dataroom constitue la surface d'API stable de cette version. Il expose les outils ci-dessous pour lire et gérer vos salles de données, regroupés selon leur fonction : outils de lecture, outils de dossiers, outils de fichiers (cycle de vie et versions des fichiers), un outil de texte de document, outils de permissions et outils de Q&R.

Connexion : https://app.waafir.io/api/mcp/waafir, ou le serveur de domaine https://app.waafir.io/api/mcp/waafir-dataroom — voir Configuration.

Noms des outils. Chaque outil est présenté ci-dessous sous le nom que liste waafir, par exemple dataroom_list_files. Le serveur de domaine liste l'ancien nom indiqué sous chaque titre comme « Nom sur l'endpoint de domaine », par exemple list_files, et waafir accepte toujours ce nom si un client l'appelle. Lorsque la description ou le résultat d'un outil nomme un autre outil à appeler ensuite (next_step, restore_with, undo_with), il le nomme tel que le liste l'endpoint auquel vous êtes connecté. Les descriptions de cette page utilisent les noms de l'endpoint de domaine.

Comment l'accès est contrôlé

Sur cette page, jeton désigne l'identifiant utilisé par votre assistant : une connexion établie en vous connectant, ou un Personal Access Token. Tous deux portent une portée et, éventuellement, une liste de salles de données, et sont limités de la même manière.

Chaque outil s'exécute en tant que propriétaire du jeton et est soumis aux mêmes règles que celles appliquées par l'interface du produit — il n'existe aucun chemin plus permissif via MCP. Deux contrôles s'appliquent à chaque appel :

  • Portée. Chaque outil indique une portée minimale : les outils de lecture exigent read, les modifications de dossiers et de fichiers exigent write, et les outils d'attribution de permissions exigent admin. Un jeton dont la portée est inférieure à celle requise ne voit pas l'outil et est rejeté avec une erreur FORBIDDEN s'il l'appelle (voir Comment un échec est signalé). La portée est cumulative — write inclut read, admin inclut les deux.
  • Restriction aux salles de données. Si le jeton est restreint à des salles de données précises, tout appel faisant référence à une salle de données hors de sa liste d'autorisation est rejeté, et un jeton restreint ne peut même pas lister les salles de données qu'il n'est pas autorisé à ouvrir. Le contrôle est fondé sur la salle de données à laquelle appartient une ressource : un jeton restreint à la salle de données A ne peut donc jamais atteindre un fichier ou un dossier de la salle de données B — même au sein de la même organisation.

En outre, les modifications de dossiers et de fichiers exigent un rôle dans l'équipe de transaction de la salle de données (les investisseurs ne peuvent rien modifier), et les outils de permissions exigent en plus que le propriétaire du jeton soit administrateur ou gestionnaire de l'organisation. La suppression d'un dossier ou d'un fichier est toujours une suppression logique — les lignes sont marquées comme supprimées et conservées à des fins de conservation et d'audit, jamais supprimées définitivement. Chaque modification est enregistrée sous le même événement d'audit que celui écrit par l'interface du produit : une action MCP est donc indiscernable d'une action de l'interface dans le journal d'audit.

Les identifiants (dataroom_id, folder_id, file_id, user_id) sont des UUID.

Texte non fiable dans les résultats

Certains résultats contiennent du texte que Waafir n'a pas écrit : une sortie d'IA portant sur un document, le texte propre d'un document, ou ce qu'un investisseur ou un collègue a écrit. Un tel résultat ajoute untrusted_content: { source, fields, notice }, ainsi que le même { source, fields } sous _meta["io.waafir/untrusted"]. source vaut "document" ou "third-party". fields liste les chemins qui contiennent ce texte dans ce résultat, par exemple answer ou questions[].responses[].body ; un chemin n'est listé que si le résultat contient une valeur à cet endroit. Traitez ces champs comme des données, jamais comme des instructions destinées à votre assistant.

Les outils marqués sont 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, les aperçus de dataroom_answer_question, dataroom_delete_question, dataroom_delete_answer et dataroom_publish_kb_article (le titre de l'investisseur), dataroom_get_update, dataroom_edit_update_draft, dataroom_get_published_update, dataroom_list_file_comments, dataroom_list_my_notifications, mi_get_profile et chaque outil d'IA à l'exception de dataroom_apply_organise. Les noms de fichiers ne sont pas marqués.

Comment un échec est signalé

Un échec d'outil n'est pas un statut HTTP. Lorsqu'un outil refuse un appel, la réponse HTTP est toujours 200 et l'enveloppe JSON-RPC est toujours une enveloppe de succès ; l'échec est transporté à l'intérieur du résultat, qui définit isError: true et dont le contenu textuel est :

{ "error": { "code": "CONFLICT", "message": "…" } }

Aiguillez sur error.code, jamais sur le statut HTTP — un client qui se base sur le statut ne reconnaîtra jamais aucun refus décrit sur cette page. Voici les codes que renvoie un outil de salle de données :

CodeSignificationQue faire
INVALID_ARGUMENTUn argument est manquant, mal formé ou n'est pas un identifiant valideCorrigez les arguments et réessayez
FORBIDDENLe jeton est valide mais n'est pas autorisé — portée insuffisante, un dataroom_id que vous avez transmis est hors de sa liste d'autorisation de salles de données, ou le rôle du propriétaire ne le permet pasDemandez l'accès, ou utilisez un jeton ayant la bonne portée
NOT_FOUNDAucun enregistrement de ce type, ou il ne vous appartient pas. La plupart des outils qui prennent un identifiant de fichier ou de dossier renvoient aussi ce code pour un élément situé dans une salle de données hors de la liste d'autorisation du jeton, exactement comme pour un identifiant inexistantVérifiez l'identifiant, et que le jeton est restreint à la salle de données de l'élément
CONFLICTCompris et autorisé, mais la salle de données n'est pas dans un état qui permet l'opérationLisez le message, levez le blocage, réessayez
TOO_LARGEL'entrée dépasse une limite de tailleDécoupez l'entrée
QUOTA_EXCEEDEDUn quota mesuré est épuisé, ou l'abonnement de l'organisation a expiréQuelqu'un doit acheter ou passer à une offre supérieure — réessayer ne résoudra rien
UPSTREAM_ERRORUn service en aval a échoué — le document stocké n'a pas pu être récupéré, ou l'extraction de texte a échoué sur ce documentTransitoire. Réessayez plus tard avant de le considérer comme fatal
UNAVAILABLEWaafir ne peut pas servir la demande pour l'instant : le fichier est encore en cours de vérification, le fichier stocké n'a pas pu être lu pour sa vérification, ou la lecture n'a pas pu être enregistrée dans le journal d'audit, le contenu a donc été retenu plutôt que divulgué sans traceTransitoire. Réessayez plus tard
INTERNALUn échec inattenduNe réessayez pas — faites remonter le problème

Ne confondez pas les deux codes « réessayer plus tard » avec « échec ». UPSTREAM_ERROR et UNAVAILABLE vous parviennent aujourd'hui depuis get_file_text, et ils signifient redemandez, pas abandonnez. Un client qui traite tout résultat non OK comme définitif transforme un incident passager en échec permanent — l'erreur même que ce tableau cherche à éviter. Notez aussi que UNAVAILABLE est un refus délibéré : Waafir préfère retenir le texte d'un document plutôt que de le remettre sans trace d'audit.

Un fichier encore en cours de vérification. Waafir vérifie chaque fichier nouvellement téléversé et chaque nouvelle version avant d'en servir le contenu. Tant que la vérification n'est pas terminée, un outil qui lit le contenu du fichier répond UNAVAILABLE avec un error.reason :

{ "error": { "code": "UNAVAILABLE", "reason": "ACTIVATION_PENDING", "message": "This file is still being checked. Try again shortly." } }

C'est transitoire : patientez un court instant et rappelez l'outil. Les versions antérieures répondaient CONFLICT ; branchez-vous sur error.reason, pas sur le message. La vérification a deux autres issues. Dans les outils de salle de données, elles ne portent pas de reason, et le message se termine par le code entre parenthèses :

  • Bloqué : le fichier a échoué à la vérification de son contenu. INVALID_ARGUMENT, avec un message qui se termine par (ACTIVATION_BLOCKED). Aucune nouvelle tentative sur ce fichier ne peut réussir.
  • Illisible : le fichier stocké n'a pas pu être lu pour le vérifier. UNAVAILABLE, avec un message qui se termine par (CONTENT_UNREADABLE). Réessayez plus tard.

Le message nomme l'enregistrement bloquant chaque fois qu'il y en a un. Les échecs au niveau transport — un nom de serveur inconnu, une connexion ou un jeton manquant ou révoqué, un module complémentaire payant non acheté — sont de véritables statuts HTTP et sont listés dans Configuration.

Pagination

Aucun outil de liste ne renvoie un tableau non borné. Chaque outil qui renvoie une liste accepte des paramètres facultatifs limit et offset, et renvoie un objet pagination à côté des lignes :

ChampSignification
limitla taille de page réellement appliquée
offsetle décalage réellement appliqué
countle nombre de lignes sur cette page
has_moretrue lorsqu'il existe d'autres lignes au-delà de cette page
next_offsetl'offset à transmettre pour la page suivante, ou null lorsque le résultat est complet
totalle nombre total de lignes derrière la fenêtre — présent uniquement lorsqu'il est peu coûteux à calculer

limit et offset sont plafonnés, pas rejetés : une valeur supérieure au maximum revient sous la forme du maximum, une valeur inférieure au minimum sous la forme du minimum, et une valeur absente ou non numérique sous la forme de la valeur par défaut documentée. Le bloc pagination indique toujours les valeurs réellement appliquées, afin que vous voyiez ce que vous avez obtenu plutôt que ce que vous avez demandé.

Utilisez has_more pour déterminer si un résultat est complet — ne le déduisez jamais de count === limit, ce qui est ambigu sur une dernière page exactement pleine. Pour lire une liste entière, suivez next_offset jusqu'à ce que has_more vaille false.


Outils de lecture

Exigent la portée read.

dataroom_list

Nom sur l'endpoint de domaine : list_datarooms

Liste les salles de données auxquelles l'appelant a accès. Pour un jeton restreint à des salles de données précises, le résultat est filtré selon cette liste d'autorisation. Les salles de données archivées sont exclues.

  • Entrées : limit (facultatif, 1–200, 50 par défaut) ; offset (facultatif, 0 par défaut).
  • Sortie : { datarooms: [{ id, name, description, org_name, created_at }], pagination: { limit, offset, count, has_more, next_offset, total } }.
  • Triées de la plus ancienne à la plus récente par created_at, avec un départage par identifiant pour que les pages soient stables. total est le nombre total de salles de données que ce jeton peut atteindre, compté après application du filtre de la liste d'autorisation.

dataroom_get

Nom sur l'endpoint de domaine : get_dataroom

Obtient une salle de données unique par son identifiant. L'appelant doit y être autorisé ; un jeton restreint à d'autres salles de données est rejeté.

  • Entrées : dataroom_id (obligatoire).
  • Sortie : { dataroom: { id, name } | null }.

dataroom_list_folders

Nom sur l'endpoint de domaine : list_folders

Liste les dossiers d'une salle de données. Respecte la visibilité équipe de transaction / investisseur — un investisseur ne voit que les dossiers qu'il peut lire. Liste un niveau sous un parent, ou transmettez all pour l'arborescence complète. Les dossiers supprimés sont exclus.

  • Entrées : dataroom_id (obligatoire) ; parent_folder_id (facultatif — omettez-le pour les dossiers de premier niveau) ; all (booléen facultatif — true liste tous les dossiers de la salle de données) ; limit (facultatif, 1–500, 100 par défaut) ; offset (facultatif, 0 par défaut).
  • Sortie : { folders: [{ id, name, parent_folder_id, created_at }], pagination: { limit, offset, count, has_more, next_offset, total } }.
  • Triés par nom, avec un départage par identifiant pour que les pages soient stables. all: true est également paginé — sur une grande arborescence, parcourez les pages avec next_offset plutôt que d'attendre l'arborescence entière en une seule réponse.

dataroom_list_files

Nom sur l'endpoint de domaine : list_files

Liste les fichiers actifs (non supprimés) d'une salle de données, éventuellement au sein d'un dossier. Les appelants investisseurs ne voient que les fichiers qu'ils sont autorisés à lire. Paginé.

  • Entrées : dataroom_id (obligatoire) ; folder_id (facultatif — omettez-le pour les fichiers à la racine de la salle de données) ; limit (facultatif, 1–200, 50 par défaut) ; offset (facultatif, 0 par défaut) ; sort_dir (facultatif, asc | desc, desc par défaut).
  • Sortie : { files: [{ id, name, folder_id, size_bytes, mime_type, created_at, updated_at }], pagination: { limit, offset, count, has_more, next_offset } }.
  • Pas de total — compter l'ensemble complet des correspondances est coûteux sur ce chemin. Utilisez has_more / next_offset pour paginer.

dataroom_get_file_metadata

Nom sur l'endpoint de domaine : get_file_metadata

Obtient les métadonnées d'un fichier unique : nom, type MIME, taille, chemin du dossier, liste des versions, et résumé/catégorie IA le cas échéant. Le fichier doit appartenir à la salle de données indiquée ; un fichier d'une autre salle de données (même dans la même organisation) renvoie null.

  • Entrées : dataroom_id (obligatoire) ; file_id (obligatoire).
  • Sortie : { 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 }.

Nom sur l'endpoint de domaine : search_dataroom

Recherche des fichiers par nom dans une seule salle de données autorisée (correspondance de sous-chaîne insensible à la casse). Les fichiers supprimés sont exclus.

  • Entrées : dataroom_id (obligatoire) ; query (obligatoire, sous-chaîne du nom de fichier) ; limit (facultatif, 1–100, 25 par défaut) ; offset (facultatif, 0 par défaut).
  • Sortie : { files: [{ id, name, mime_type, size_bytes, created_at }], pagination: { limit, offset, count, has_more, next_offset } }.
  • Du plus récent au plus ancien, avec un départage par identifiant pour que les pages soient stables. Lorsque has_more vaut true, la requête a trouvé plus de fichiers qu'il n'en a été renvoyé — paginez avec next_offset, ou affinez la requête. Il n'y a pas de total.

Outils de salle

dataroom_create

Crée une salle de données dans l'organisation du jeton.

  • Portée : write, et le propriétaire du jeton doit faire partie de l'équipe de transaction. Un jeton ou une connexion limité à des salles de données précises est refusé (FORBIDDEN, code PAT_ROOM_SCOPED) ; utilisez-en un qui n'est pas limité à des salles de données.
  • Entrées : name (obligatoire, 1–100 caractères). Les espaces de début et de fin sont supprimés, et un nom composé uniquement d'espaces est refusé (INVALID_ARGUMENT).
  • Sortie : { id, name }. Transmettez id comme dataroom_id aux outils de dossiers et de fichiers.
  • Non idempotent. Chaque appel crée une nouvelle salle. Si le résultat d'un appel a été perdu, recherchez la salle avec dataroom_list avant d'appeler à nouveau, sinon vous créerez un doublon.
  • Une organisation dont l'abonnement n'autorise pas les écritures, ou qui dépasse sa limite de sièges, est refusée avec QUOTA_EXCEEDED.

Outils de dossiers

Exigent la portée write et un rôle dans l'équipe de transaction de la salle de données.

dataroom_create_folder

Nom sur l'endpoint de domaine : create_folder

Crée un dossier dans une salle de données. Imbriquez-le sous un parent, ou omettez le parent pour la racine de la salle de données. Rejette un nom en double sous le même parent avec un CONFLICT.

  • Entrées : dataroom_id (obligatoire) ; name (obligatoire, 1–255 caractères) ; parent_folder_id (facultatif — null/omis pour la racine de la salle de données).
  • Sortie : { folder: { id, name, parent_folder_id } }. Le message CONFLICT nomme l'identifiant du dossier en conflit, vous n'avez donc pas besoin de relister le parent pour le trouver.

dataroom_rename_folder

Nom sur l'endpoint de domaine : rename_folder

Renomme un dossier. Le dossier doit appartenir à l'organisation de l'appelant.

  • Entrées : folder_id (obligatoire) ; name (obligatoire, 1–255 caractères).
  • Sortie : { folder: { id, name } }.

dataroom_delete_folder

Nom sur l'endpoint de domaine : delete_folder

Supprime logiquement un dossier et toute sa sous-arborescence — chaque sous-dossier imbriqué et chaque fichier qu'ils contiennent. Dans une vraie salle de données, cela peut représenter des centaines de documents à partir d'un seul identifiant de dossier ; le résultat indique donc exactement combien de dossiers et de fichiers ont été supprimés. Transmettez dry_run: true pour obtenir ces chiffres sans rien supprimer. Les lignes sont marquées comme supprimées, jamais supprimées définitivement, et toute la cascade peut être annulée avec restore_folder.

  • Entrées : folder_id (obligatoire) ; dry_run (booléen facultatif — aperçu uniquement).
  • Sortie : { deleted, dry_run, folder_id, folder_name, affected: { folders, files }, restore_with: "restore_folder" }.
  • Une simulation ne modifie rien et n'enregistre aucune suppression dans la piste d'audit.

dataroom_restore_folder

Nom sur l'endpoint de domaine : restore_folder

Annule un delete_folder. Restaure le dossier et tout ce que cette suppression a retiré avec lui — tout ce qui a été supprimé séparément, auparavant, reste supprimé. Renvoie un conflit si le dossier parent est toujours supprimé (restaurez-le d'abord) ou si un dossier actif a pris le nom entre-temps ; dans les deux cas, le message nomme l'identifiant du dossier bloquant.

  • Entrées : folder_id (obligatoire) ; dry_run (booléen facultatif — aperçu uniquement).
  • Sortie : { restored, dry_run, folder_id, folder_name, affected: { folders, files } }.
  • Une suppression de dossier est annulable sans perte, et délibérément différente d'une suppression de fichier. La cascade ne modifie pas le compteur de stockage de votre organisation et ne supprime pas les fragments d'index de recherche des fichiers : restore_folder ne recrédite donc rien — rien n'a été débité — et les fichiers restaurés restent consultables par la recherche. delete_file / restore_file ci-dessous font les deux. Supprimer un dossier rempli de documents n'est donc pas le même événement comptable que supprimer chacun de ces documents.

dataroom_move_folder

Nom sur l'endpoint de domaine : move_folder

Change le parent d'un dossier au sein de la même salle de données. Imbriquez-le sous un autre dossier, ou déplacez-le à la racine de la salle de données. Rejette le déplacement d'un dossier dans lui-même ou dans un descendant (cycle), dans une autre salle de données, ou là où un dossier frère portant le même nom existe déjà.

  • Entrées : folder_id (obligatoire) ; new_parent_folder_id (facultatif — null/omis pour la racine de la salle de données).
  • Sortie : { folder: { id, name, parent_folder_id, previous_parent_folder_id } }. Retransmettez previous_parent_folder_id comme new_parent_folder_id pour annuler le déplacement.

Outils de fichiers

Les modifications de fichiers exigent la portée write ; get_file_download_url exige read plus l'autorisation Lire le contenu des documents sur le jeton.

Le téléversement passe par un intermédiaire, et MCP ne transporte jamais les octets. Les arguments des outils sont du JSON, le protocole n'a donc aucun canal binaire : request_file_upload génère une URL présignée et votre client y envoie directement le contenu par PUT. Un client qui ne peut pas émettre un PUT HTTP avec un corps binaire brut ne peut pas du tout mener un téléversement à bien — mieux vaut le savoir avant de commencer qu'après.

L'outil qui finalise le téléversement dépend de la présence ou non d'un fichier de ce nom, et vous n'avez pas à le déterminer : request_file_upload renvoie un champ next_step qui nomme l'outil à appeler.

request_file_upload renvoieSignificationFinaliser avec
is_new_version: false, next_step: "register_file"Aucun fichier actif du même nom — un enregistrement en attente a été créé en version 1register_file
is_new_version: true, next_step: "finalise_file_version"Un fichier actif du même nom existe — ce téléversement en devient une nouvelle versionfinalise_file_version

Appelez l'outil que nomme next_step. register_file ne finalise jamais que la version 1 et rejette tout le reste : y recourir dans le cas d'une nouvelle version fait échouer l'appel.

dataroom_request_file_upload

Nom sur l'endpoint de domaine : request_file_upload

Demande une URL de téléversement présignée pour un fichier dans une salle de données. Renvoie l'URL et les en-têtes vers lesquels envoyer les octets par PUT, l'identifiant du fichier et next_step — l'outil qui finalise ce téléversement précis. Si un fichier actif du même nom existe déjà dans le dossier cible, is_new_version vaut true et l'identifiant et le version_number renvoyés ciblent ce fichier existant.

  • Portée : write.
  • Entrées : dataroom_id (obligatoire) ; file_name (obligatoire, avec extension) ; file_size (obligatoire, nombre exact d'octets, entier positif) ; mime_type (obligatoire) ; folder_id (facultatif — omettez-le pour la racine de la salle de données).
  • Sortie : { upload_url, headers, file_id, s3_key, is_new_version, version_number, next_step } — next_step vaut "register_file" ou "finalise_file_version".
  • Cet outil ne déplace aucun octet ; il se contente de fournir l'URL. Si le stockage objet n'est pas configuré, l'appel échoue purement et simplement plutôt que de renvoyer une URL qui ne peut pas fonctionner.

dataroom_register_file

Nom sur l'endpoint de domaine : register_file

Finalise un premier téléversement en attente après l'envoi par PUT des octets obtenus via request_file_upload : marque le fichier comme actif, incrémente le stockage de l'organisation et enregistre la version 1. Appelez-le lorsque request_file_upload a renvoyé is_new_version: false — son next_step nomme cet outil.

  • Portée : write.
  • Entrées : file_id (obligatoire, l'identifiant en attente renvoyé par request_file_upload) ; s3_key (facultatif) ; size_bytes (facultatif — déduit de l'objet téléversé s'il est omis).
  • Sortie : { file_id, status: "active", version_number: 1 }.
  • Version 1 uniquement, et l'outil l'impose. Un fichier déjà actif, ou qui possède déjà une version, est rejeté — le refus désigne finalise_file_version comme l'outil pour les versions 2 et suivantes.
  • La clé de stockage est déduite côté serveur et le s3_key du client n'est jamais considéré comme fiable. Il est facultatif ; si vous l'envoyez, il doit être égal à la clé renvoyée par request_file_upload, faute de quoi l'appel est rejeté.

dataroom_finalise_file_version

Nom sur l'endpoint de domaine : finalise_file_version

Finalise une nouvelle version d'un fichier existant, après l'envoi par PUT des octets vers l'URL que request_file_upload a renvoyée avec is_new_version: true. C'est l'équivalent MCP du remplacement d'un document dans l'interface, et l'outil que nomme next_step dans ce cas.

  • Portée : write.
  • Entrées : file_id (obligatoire) ; version_number (obligatoire — le version_number renvoyé par request_file_upload).
  • Sortie : { file_id, version_id, version_number, size_bytes, is_current: true, previous_version_number, previous_version_id, undo_with: "restore_file_version" }.
  • version_number doit être exactement la version suivante de ce fichier. Elle est vérifiée, pas devinée : toute autre valeur est rejetée plutôt qu'écrite en silence, et la clé de stockage en est déduite côté serveur.
  • La nouvelle version devient la version courante et la précédente est conservée dans l'historique. Transmettez previous_version_id à restore_file_version pour annuler.
  • Un fichier dont le premier téléversement n'est pas terminé est rejeté — finalisez d'abord la version 1 avec register_file. L'appel échoue aussi si les octets ne sont pas encore réellement dans le stockage, plutôt que d'enregistrer une version qui ne repose sur rien.

dataroom_restore_file_version

Nom sur l'endpoint de domaine : restore_file_version

Rend de nouveau courante une version antérieure d'un fichier — l'annulation de finalise_file_version. Il déplace le marqueur de version courante et fait pointer le fichier vers cette version ; il ne crée pas de nouvelle ligne de version, de sorte que l'historique des versions reste une liste fidèle des révisions réellement téléversées.

  • Portée : write.
  • Entrées : file_id (obligatoire) ; version_id (obligatoire — doit appartenir à ce fichier ; get_file_metadata liste les identifiants de version du fichier).
  • Sortie : { file_id, version_id, version_number, already_current, new_version_created: false }.
  • already_current: true signifie que la version était déjà la version courante et que rien n'a changé — une opération sans effet, pas un échec.
  • Il n'existe pas d'outil distinct pour lister les versions : get_file_metadata renvoie déjà les versions du fichier avec leurs identifiants, leurs numéros et l'indicateur de version courante.

dataroom_rename_file

Nom sur l'endpoint de domaine : rename_file

Renomme un fichier — métadonnées uniquement. Cela ne crée pas de nouvelle version ; le versionnage sert au remplacement du contenu, pas au changement de libellé. Les noms doivent être uniques parmi les fichiers actifs d'un même dossier ; un conflit renvoie un CONFLICT qui nomme le fichier existant.

  • Portée : write.
  • Entrées : file_id (obligatoire) ; name (obligatoire, 1–255 caractères).
  • Sortie : { file_id, name, previous_name, changed }. Le name renvoyé est relu depuis le stockage : c'est donc ce qui a réellement été enregistré — changed vaut false si le nom stocké n'a pas changé.

dataroom_move_file

Nom sur l'endpoint de domaine : move_file

Déplace un fichier vers un autre dossier de la même salle de données, ou vers la racine de la salle de données. Les déplacements entre salles de données sont rejetés : une salle de données est une frontière de permissions, et y faire passer du contenu changerait qui peut le lire. Rejette un déplacement lorsqu'un fichier actif du même nom se trouve déjà à destination.

  • Portée : write.
  • Entrées : file_id (obligatoire) ; folder_id (facultatif — null/omis pour la racine de la salle de données).
  • Sortie : { file_id, name, folder_id, previous_folder_id, moved }. Retransmettez previous_folder_id comme folder_id pour annuler le déplacement.

dataroom_delete_file

Nom sur l'endpoint de domaine : delete_file

Supprime un fichier. Le résultat reprend le nom du fichier réellement supprimé, de sorte qu'un identifiant erroné est visible dans la réponse. Le fichier et ses versions sont conservés à des fins de conservation et d'audit, jamais effacés, et restore_file le rétablit.

  • Portée : write.
  • Entrées : file_id (obligatoire).
  • Sortie : { file_id, status: "deleted", name, folder_id, restore_with: "restore_file" }.
  • Le stockage n'est recrédité que pour un téléversement réellement terminé. Un fichier dont les octets sont arrivés restitue sa taille au compteur de stockage de votre organisation. Un fichier encore en attente de téléversement n'a jamais été comptabilisé au départ, donc le supprimer ne modifie en rien le compteur — la suppression est neutre pour le compteur, et non un remboursement d'octets que vous n'avez jamais stockés.
  • La suppression retire aussi les fragments d'index de recherche du fichier, de sorte que le document disparaît immédiatement de la recherche documentaire. restore_file ne peut pas les rétablir — voir ci-dessous.
  • L'outil ne résout jamais qu'un fichier actif : l'appeler une seconde fois sur le même identifiant renvoie donc NOT_FOUND au lieu de supprimer à nouveau quoi que ce soit. Le compteur de stockage ne peut pas être débité deux fois pour un même fichier.

dataroom_restore_file

Nom sur l'endpoint de domaine : restore_file

Annule un delete_file : rend de nouveau actif un fichier supprimé logiquement, en restaurant la ligne et la comptabilité de stockage que la suppression avait inversée. Il ne restaure pas les fragments d'index de recherche du fichier — ceux-ci sont retirés lors de la suppression — de sorte que le fichier est actif et téléchargeable mais doit être réindexé avant que la recherche documentaire le retrouve. search_index_restored vaut toujours false et le dit explicitement plutôt que de laisser croire à une annulation sans perte.

  • Portée : write.
  • Entrées : file_id (obligatoire).
  • Sortie : { restored, file_id, name, folder_id, storage_bytes_restored, search_index_restored: false }.

Lorsqu'une restauration est refusée. Elle échoue plutôt que de masquer un conflit, et nomme la ligne bloquante lorsqu'il y en a une :

#Conditionerror.codeQue faire
1Aucun fichier de ce type, ou il ne vous appartient pasNOT_FOUNDVérifiez l'identifiant.
2Le fichier n'est pas supprimé — il est déjà actifCONFLICTRien à restaurer.
3Le téléversement du fichier n'a jamais aboutiCONFLICTRien à restaurer : ses octets ne sont jamais arrivés, il n'y a donc aucun document à rétablir. Téléversez-le de nouveau à la place.
4Le dossier qui le contient est toujours suppriméCONFLICTCommencez par restore_folder — cela rétablit aussi les fichiers supprimés avec lui.
5Un fichier actif a pris le nom entre-temps dans ce dossierCONFLICTRenommez le fichier qui porte ce nom, puis réessayez.

Il s'agit de codes transmis dans la charge utile, pas de statuts HTTP — voir Comment un échec est signalé.

Les contrôles s'exécutent dans l'ordre numéroté ci-dessus, et c'est le premier qui échoue qui vous est signalé. Le cas du téléversement jamais abouti (3) est donc signalé après les contrôles d'existence et de suppression mais avant les contrôles de dossier et de nom : un fichier dont les octets ne sont jamais arrivés ne peut pas être restauré quelle que soit la situation de son dossier ou de son nom, il est donc inutile de vous demander de corriger l'un ou l'autre.

dataroom_get_file_download_url

Nom sur l'endpoint de domaine : get_file_download_url

Obtient une URL de téléchargement de courte durée pour un fichier. L'appelant doit être autorisé pour le fichier (permission de lecture/téléchargement par fichier). L'URL sert la même copie que celle obtenue par un téléchargement dans le navigateur : filigranée lorsque la salle applique un filigrane aux téléchargements, et la copie caviardée d'un document caviardé pour un destinataire extérieur à votre organisation. Elle expire au bout de quelques minutes.

  • Portée : read, plus l'autorisation Lire le contenu des documents sur le jeton. Sans elle, l'appel est refusé avec GRANT_REQUIRED.
  • Limite : au plus 10 appels par minute et par jeton, car chacun prépare une copie protégée. Au-delà, RATE_LIMITED.
  • Si une copie protégée ne peut pas être préparée à temps, l'appel est refusé avec UNAVAILABLE et sans lien ; réessayez, ou téléchargez le fichier dans Waafir.
  • Entrées : file_id (obligatoire).
  • Sortie : { download_url, expires_in_seconds }.

Outils de texte de document

Un seul outil, pour lire le texte extrait d'un document plutôt que de télécharger le fichier lui-même.

dataroom_get_file_text

Nom sur l'endpoint de domaine : get_file_text

Lit le texte extrait d'un document, une page à la fois. Renvoie des segments numérotés — pour un PDF, un segment par page, sauf si la page est très longue — plus un bloc pagination, afin que vous puissiez parcourir un long document avec offset.

Deux éléments rendent cet outil plus strict qu'une lecture de métadonnées :

  • Vous devez être autorisé à télécharger le fichier, pas seulement à le consulter. Une permission de consultation seule ne suffit pas, et un jeton dont l'accès au document est restreint est refusé.
  • Si le document a été caviardé et que vous ne faites pas partie de l'équipe de transaction, vous recevez le texte de la version caviardée, et source indique quel artefact vous avez obtenu. Il ne remet jamais en silence l'original à un lecteur extérieur au périmètre.

Chaque appel réussi est inscrit dans le journal d'audit de l'organisation, au même titre que la lecture d'un document dans le produit.

  • Portée : read, plus l'autorisation Lire le contenu des documents sur le jeton. Sans elle, l'appel est refusé avec GRANT_REQUIRED ; dataroom_get_file_metadata et dataroom_summarise_file fournissent toujours le résumé du document.
  • Entrées : file_id (obligatoire) ; dataroom_id (facultatif — validé par rapport à la propre salle de données du fichier lorsqu'il est fourni, et une non-correspondance se traduit par NOT_FOUND plutôt que de confirmer que le fichier existe ailleurs) ; limit (facultatif, 1–5, 3 par défaut) ; offset (facultatif, 0 par défaut).
  • Sortie : { file_id, file_name, source, segment_max_chars, segments, pagination }. source vaut "original" ou "redacted". pagination comporte un total.
  • Un fichier sans objet stocké — une note, dont le corps est conservé en ligne — renvoie NOT_FOUND avec « no extractable content ».
  • Un fichier dont le type ne comporte aucun texte à extraire (une archive, par exemple) est refusé avec un 400, et un fichier stocké de plus de 50 Mo avec un 413 (FILE_TOO_LARGE). Ces deux cas ne s'appliquent que lorsque le texte du fichier n'a pas déjà été extrait (le texte déjà extrait est servi en priorité), sont refusés avant la récupération du document, et aucun n'est une erreur « réessayer plus tard ».
  • C'est l'outil qui produit les deux codes « réessayer plus tard » : UPSTREAM_ERROR lorsque le document stocké ne peut pas être récupéré ou que l'extraction de texte échoue, et UNAVAILABLE lorsque l'écriture d'audit de la lecture échoue — auquel cas le texte est délibérément retenu plutôt que divulgué sans trace. Les deux méritent une nouvelle tentative avant de considérer le document comme illisible.

Outils de permissions

Ces outils lisent et modifient qui peut voir quoi. Les trois outils de lecture n'exigent que la portée read (les deux outils d'annuaire exigent en plus un rôle dans l'équipe de transaction) ; les quatre outils d'attribution/de révocation exigent la portée admin et un propriétaire de jeton qui soit administrateur ou gestionnaire de l'organisation.

Un jeton ne porte jamais la dérogation propriétaire/administrateur sur les fichiers restreints. Dans l'application, un propriétaire ou un administrateur de l'organisation voit chaque fichier restreint ; via un jeton, il n'en atteint un que s'il l'a créé ou détient une autorisation dessus, exactement comme n'importe quel autre membre. Un outil de fichier refusé sur un tel fichier répond NOT_FOUND avec le même texte que pour un fichier inexistant (« File not found in the requested dataroom, or not readable by this credential »), de sorte que la réponse ne confirme jamais qu'un fichier restreint existe.

dataroom_get_file_permissions

Nom sur l'endpoint de domaine : get_file_permissions

Liste les autorisations sur un fichier (directes et héritées d'un dossier). Reflète la vue des permissions de fichier de l'interface.

  • Portée : read.
  • Entrées : dataroom_id (obligatoire) ; file_id (obligatoire) ; limit (facultatif, 1–200, 50 par défaut) ; offset (facultatif, 0 par défaut).
  • Sortie : { 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 } (source vaut "direct" ou "inherited").
  • Les autorisations sont triées par created_at, puis user_id, puis source, puis source_folder_id, de sorte que les pages sont stables d'un appel à l'autre. total est le nombre total d'autorisations sur le fichier.
  • Les champs d'identité (user_email, user_name, granted_by_email) suivent la même règle de visibilité que les outils d'annuaire ci-dessous : ils apparaissent pour les appelants de l'équipe de transaction, les identités des investisseurs exigent en plus un administrateur ou un gestionnaire de l'organisation, et lorsque vous n'y êtes pas autorisé, les clés sont absentes plutôt que null. identities_visible vous indique dans quel cas vous vous trouvez ; les autorisations elles-mêmes sont toujours listées.

dataroom_list_users

Nom sur l'endpoint de domaine : list_dataroom_users

Liste les utilisateurs qui détiennent une autorisation d'accès active sur une salle de données, avec le user_id qu'exigent les outils de permissions, ainsi que l'adresse e-mail et le nom de chaque bénéficiaire. C'est généralement le premier appel lorsque vous avez besoin d'un user_id.

  • Portée : read, et un rôle dans l'équipe de transaction de l'organisation de la salle de données (le même contrôle que pour la page de l'équipe).
  • Entrées : dataroom_id (obligatoire) ; limit (facultatif, 1–200, 50 par défaut) ; offset (facultatif, 0 par défaut).
  • Sortie : { 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 }.
  • Les identités des investisseurs sont omises, sauf si vous êtes administrateur ou gestionnaire de l'organisation ; investor_rows_visible indique quel ensemble vous avez reçu.
  • Ne liste que les bénéficiaires explicites. Les propriétaires et administrateurs de l'organisation ont un accès implicite sans ligne d'autorisation et n'apparaîtront pas — identifiez-les avec find_user_by_email.

dataroom_find_user_by_email

Nom sur l'endpoint de domaine : find_user_by_email

Résout une adresse e-mail en user_id exigé par les outils de permissions, avec le rôle de l'utilisateur dans l'organisation et sa permission actuelle dans cette salle de données.

  • Portée : read, et un rôle dans l'équipe de transaction de l'organisation de la salle de données. Résoudre un investisseur exige en plus un administrateur ou un gestionnaire de l'organisation.
  • Entrées : dataroom_id (obligatoire) ; email (obligatoire, comparé sans tenir compte de la casse).
  • Sortie : { found: true, user: { user_id, email, name, org_role, dataroom_permission } } ou { found: false }. Un dataroom_permission à null signifie que l'utilisateur fait partie de l'organisation mais n'a pas encore accès à cette salle — invitez-le d'abord.
  • Il ne s'agit pas d'une recherche dans un annuaire global : seuls les utilisateurs de l'organisation propre à la salle de données, ou disposant d'un accès actif à celle-ci, sont résolus. Une adresse inconnue, un utilisateur extérieur à votre tenant et un utilisateur que vous n'êtes pas autorisé à voir renvoient tous un { found: false } identique, de sorte qu'une réponse négative ne révèle jamais si un compte existe.

dataroom_set_file_permissions

Nom sur l'endpoint de domaine : set_file_permissions

Accorde ou met à jour la permission de lecture/téléchargement d'un utilisateur sur un fichier. Un jeton read/write, ou un propriétaire qui n'est pas administrateur ou gestionnaire de l'organisation, est rejeté.

  • Portée : admin.
  • Entrées : dataroom_id (obligatoire) ; file_id (obligatoire) ; user_id (obligatoire) ; can_read (booléen obligatoire) ; can_download (booléen obligatoire) ; expires_at (horodatage ISO facultatif, doit être dans le futur).
  • Sortie : { success: true, effective: { can_read, can_download } } — la décision après attribution, qui tient compte des restrictions du fichier et de l'héritage des dossiers et peut donc différer de ce que vous avez demandé.
  • Cet outil accorde l'accès ; il ne peut pas le retirer. Transmettre can_read: false écrit une autorisation active avec lecture refusée, que d'autres autorisations (appartenance à l'organisation, autorisation sur la salle de données, héritage de dossier) peuvent encore supplanter. Pour retirer réellement l'accès d'un utilisateur à un fichier, utilisez revoke_file_permission.

dataroom_revoke_file_permission

Nom sur l'endpoint de domaine : revoke_file_permission

Retire l'autorisation directe d'un utilisateur sur un fichier (révocation logique : la ligne est conservée pour la piste d'audit). Renvoie revoked: false si l'utilisateur n'avait aucune autorisation directe sur le fichier.

  • Portée : admin.
  • Entrées : dataroom_id (obligatoire) ; file_id (obligatoire) ; user_id (obligatoire).
  • Sortie : { success: true, revoked }.
  • N'affecte que l'autorisation directe. L'accès hérité d'une permission de dossier n'est pas affecté et doit être révoqué sur le dossier. Réversible en accordant de nouveau l'accès avec set_file_permissions.

dataroom_invite_user

Nom sur l'endpoint de domaine : invite_user_to_dataroom

Accorde à un utilisateur connu un accès au niveau de la salle de données avec un niveau de permission donné — une autorisation d'accès directe (pas une invitation par e-mail). Idempotent (upsert).

  • Portée : admin.
  • Entrées : dataroom_id (obligatoire) ; user_id (obligatoire) ; permission (obligatoire — parmi viewer, downloader, contributor, manager) ; expires_at (horodatage ISO facultatif, doit être dans le futur).
  • Sortie : { success: true, grant_id }.

dataroom_remove_user

Nom sur l'endpoint de domaine : remove_user_from_dataroom

Révoque l'accès d'un utilisateur au niveau de la salle de données (révocation logique : définit revoked_at, en préservant la piste d'audit). Renvoie revoked: false si l'utilisateur n'avait aucune autorisation active.

  • Portée : admin.
  • Entrées : dataroom_id (obligatoire) ; user_id (obligatoire).
  • Sortie : { success: true, revoked }.

Outils d'administration de salle

Autorisations sur les dossiers, autorisations sur de nombreux fichiers à la fois, et filigrane de téléchargement de la salle. Chacun exécute les mêmes contrôles et écrit les mêmes lignes que l'écran Waafir qu'il reproduit. Les écritures exigent la portée admin et un propriétaire de jeton qui soit administrateur de l'organisation. Les destinataires sont toujours un user_id (obtenu via find_user_by_email ou list_dataroom_users), jamais une adresse e-mail.

dataroom_get_folder_permissions

Liste les autorisations directes sur un dossier, et indique s'il est restreint (par lui-même, ou via un dossier parent restreint).

  • Portée : read, et le propriétaire du jeton doit faire partie de l'équipe de transaction.
  • Entrées : dataroom_id (obligatoire) ; folder_id (obligatoire).
  • Sortie : { folder_id, restricted, effectively_restricted, permissions: [{ user_id, can_read, can_download, expires_at, access_revoked, user_email?, user_name? }] }. Les clés d'identité sont absentes lorsque vous n'êtes pas autorisé à voir la personne concernée.
  • Un dossier que vous ne pouvez pas voir répond NOT_FOUND, comme un dossier inexistant.

dataroom_set_folder_permissions

Accorde à des utilisateurs l'accès à un dossier, ou le leur refuse avec can_read: false, éventuellement sur toute l'arborescence.

  • Portée : admin.
  • Entrées : dataroom_id, folder_id, grants (obligatoires : [{ user_id, can_read, can_download, expires_at? }]) ; recursive (false par défaut).
  • Sortie : { success: true, recursive, granted, skipped: { count, items } }.
  • Chaque bénéficiaire doit déjà faire partie de la salle. Un expires_at passé est refusé. Une autorisation qu'un refus sur un dossier supérieur annulerait est refusée (CONFLICT) avant toute écriture. Une autorisation récursive ignore les enfants sur lesquels le bénéficiaire fait l'objet d'un refus, et les liste dans skipped. Les bénéficiaires reçoivent la notification « Accès accordé » dans l'application.

dataroom_revoke_folder_permission

Révoque l'autorisation directe d'un utilisateur sur un dossier, ou lève son refus.

  • Portée : admin.
  • Entrées : dataroom_id, folder_id, user_id (tous obligatoires).
  • Sortie : { success: true, revoked }. revoked: false signifie qu'il n'existait aucune autorisation active.
  • Cela ne se propage pas : les autorisations qu'une attribution récursive a écrites sur les descendants du dossier sont conservées.

dataroom_bulk_set_file_permissions

Accorde aux mêmes utilisateurs l'accès à de nombreux fichiers à la fois. En mode: "add" (le mode par défaut), il ne fait qu'ajouter : un champ que vous omettez ne retire jamais d'accès. En mode: "replace", il remplace chaque autorisation exactement telle qu'indiquée, et peut donc retirer le téléchargement, effacer une date d'expiration ou rétablir un accès révoqué. Le remplacement se fait en deux étapes : le premier appel renvoie un aperçu et un confirm_token, et la répétition avec le jeton l'applique, à condition qu'aucune autorisation de la sélection n'ait changé entre-temps.

  • Portée : admin.
  • Entrées : dataroom_id, file_ids (jusqu'à 200), grants (tous obligatoires) ; mode ; confirm_token.
  • Sortie : { success: true, mode, total_grants, left_revoked_user_ids }.
  • Un identifiant de fichier qui n'est pas dans la salle, ou que vous ne pouvez pas voir, fait refuser toute la requête avec NOT_FOUND.
  • Chaque fichier doit se trouver dans la salle et vous être visible, et chaque bénéficiaire doit déjà faire partie de la salle. Si un refus sur un dossier devait annuler une autorisation, toute la requête est refusée avant l'écriture du moindre fichier.
  • Si l'accès d'un bénéficiaire a été révoqué, un add ne le rétablit pas, et le bénéficiaire est listé dans left_revoked_user_ids.

dataroom_bulk_revoke_file_permissions

Révoque les autorisations directes des utilisateurs indiqués sur de nombreux fichiers à la fois. Les autorisations sur les dossiers et l'accès à la salle ne sont pas touchés.

  • Portée : admin.
  • Entrées : dataroom_id, file_ids (jusqu'à 200), user_ids (tous obligatoires).
  • Sortie : { success: true, revoked_count }.
  • Un identifiant de fichier qui n'est pas dans la salle, ou que vous ne pouvez pas voir, fait refuser toute la requête avec NOT_FOUND.

dataroom_get_watermark_settings

Lit les modes de filigrane de téléchargement de la salle, pour les téléchargements de fichiers individuels et groupés : two_layer (l'identité de la personne qui télécharge plus une couche IP et date propre à chaque téléchargement), ou static (identité uniquement). En lecture seule : modifiez-les dans les paramètres de Waafir.

  • Portée : read, et le propriétaire du jeton doit être administrateur de l'organisation et faire partie de l'équipe de transaction.
  • Entrées : dataroom_id (obligatoire).
  • Sortie : { dataroom_id, single, bulk, stored: { single, bulk } }. Un null dans stored signifie que la salle ne l'a jamais défini, c'est donc la valeur par défaut qui s'applique.

dataroom_archive

Archive une salle de données, qui disparaît alors des listes de salles. En deux étapes : le premier appel ne modifie rien et renvoie un aperçu (le nom de la salle et le nombre de fichiers, de dossiers, de personnes ayant accès et de liens de partage actifs qu'elle comporte) ainsi qu'un confirm_token. Répétez l'appel avec le jeton pour archiver.

  • Portée : admin, et le propriétaire du jeton doit être propriétaire ou administrateur de l'organisation.
  • Entrées : dataroom_id (obligatoire) ; confirm_token.
  • Sortie : { success: true, dataroom_id, name, archived: true, restore_with: 'dataroom_restore' }.
  • L'archivage ne révoque pas les accès ni les autorisations de quiconque, et rien n'est supprimé. La salle disparaît des listes, et les lectures au niveau de la salle (get_dataroom, list_files, list_folders, recherche, Q&R, questions à l'IA) répondent NOT_FOUND jusqu'à sa restauration. Un lien direct vers l'un de ses fichiers l'ouvre toujours. dataroom_restore rétablit la salle : conservez donc le dataroom_id. La dernière salle de données active ne peut pas être archivée (CONFLICT). Aucun outil ne supprime une salle de données.

dataroom_restore

Restaure une salle de données que votre organisation a archivée. Elle réapparaît dans les listes de salles, et tout ce que l'archivage avait masqué revient avec elle : recherche IA, synthèses, mises à jour investisseurs, Q&R et modules complémentaires de la salle. Les dossiers, fichiers et accès sont tels qu'ils étaient, car l'archivage n'en a modifié aucun. Un seul appel, sans étape de confirmation.

  • Portée : admin, et le propriétaire du jeton doit être propriétaire ou administrateur de l'organisation.
  • Entrées : dataroom_id (obligatoire) : l'identifiant renvoyé par dataroom_archive.
  • Sortie : { success: true, dataroom_id, name, archived: false }.
  • Une salle qui n'est pas archivée est refusée (CONFLICT, code NOT_ARCHIVED). Une salle archivée par le support Waafir, ou avec son organisation, est refusée (CONFLICT, code SUPPORT_RESTORE_ONLY) : seul le support peut la restaurer.
  • Refusé tant que l'abonnement est inactif ou que l'équipe dépasse sa limite de sièges.

dataroom_rename

Renomme une salle de données.

  • Portée : write, et le propriétaire du jeton doit faire partie de l'équipe de transaction.
  • Entrées : dataroom_id, name (tous deux obligatoires). Le nom est nettoyé de ses espaces superflus et doit comporter de 1 à 100 caractères.
  • Sortie : { success: true, dataroom_id, name }.
  • La piste d'audit enregistre l'ancien et le nouveau nom.

Outils d'équipe

L'équipe de l'organisation est commune à toute l'organisation : un jeton limité à des salles de données précises est donc refusé (FORBIDDEN, code PAT_ROOM_SCOPED).

dataroom_team_list_members

Liste les membres actifs de l'organisation. Les invitations en attente ne sont pas incluses.

  • Portée : read, et le propriétaire du jeton doit faire partie de l'équipe de transaction.
  • Entrées : aucune.
  • Sortie : { members: [{ membership_id, user_id, email, name, role, last_active_at }] }. role vaut owner, admin ou member.

Les écritures ci-dessous nécessitent un jeton de portée admin dont le propriétaire est propriétaire ou administrateur de l'organisation. Les quatre outils marqués « en deux étapes » renvoient un aperçu et un confirm_token au premier appel, et n'agissent que lorsque l'appel est répété avec ce jeton.

dataroom_team_invite_member

Invite une personne par e-mail. En deux étapes ; la confirmation envoie l'e-mail d'invitation.

  • Portée : admin, plus l'autorisation Envoyer à des personnes en dehors de votre organisation.
  • Entrées : email, role (owner, admin ou member) (obligatoires) ; confirm_token.
  • Sortie : { membership_id, email, role, status: "pending" }. Jamais le lien d'invitation.
  • Seul un propriétaire peut inviter un propriétaire. La limite de sièges et les limites quotidiennes d'invitations s'appliquent.

dataroom_team_change_member_role

Modifie le rôle d'un membre actif. En deux étapes ; l'aperçu indique l'ancien et le nouveau rôle.

  • Portée : admin.
  • Entrées : membership_id, role (obligatoires) ; confirm_token.
  • Sortie : { success: true, membership_id, old_role, role }.
  • Seul un propriétaire peut modifier le rôle d'un propriétaire ou promouvoir quelqu'un propriétaire. Vous ne pouvez pas modifier votre propre rôle, et le dernier propriétaire ne peut pas être rétrogradé.

dataroom_team_remove_member

Retire un membre, ou révoque une invitation en attente. En deux étapes ; l'aperçu indique combien d'autorisations sur des fichiers et des dossiers et de liens de partage du membre prennent fin.

  • Portée : admin.
  • Entrées : membership_id (obligatoire) ; confirm_token.
  • Sortie : { success: true, membership_id, action, file_grants_ended?, folder_grants_ended?, share_links_deactivated? }.
  • Le retrait met fin à ses autorisations dans cette organisation et désactive les liens de partage qu'il a créés ; les refus sont conservés. Seul un propriétaire peut retirer un propriétaire.

dataroom_team_resend_invite

Renvoie une invitation en attente avec un nouveau lien ; l'ancien lien cesse de fonctionner. En deux étapes ; la confirmation envoie l'e-mail d'invitation.

  • Portée : admin, plus l'autorisation Envoyer à des personnes en dehors de votre organisation.
  • Entrées : membership_id (obligatoire) ; confirm_token.
  • Sortie : l'aperçu (membership_id, email, role) au premier appel ; { success: true, membership_id } une fois confirmé.
  • Seule une invitation en attente peut être renvoyée : toute autre adhésion est refusée dès l'aperçu, sans jeton. Les limites quotidiennes d'invitations sont décomptées au moment de la confirmation.

Outils investisseurs et NDA

Outils portant sur votre liste d'investisseurs, le NDA de votre organisation et les NDA de vos sociétés investisseuses. Chacun vérifie le rôle actuel du propriétaire du jeton dans votre organisation à chaque appel : une personne rétrogradée entre-temps, ou un jeton plafonné en dessous du rôle requis par l'outil, est donc refusé.

Les outils qui lisent l'ensemble de l'organisation nécessitent un jeton qui n'est pas limité à certaines salles de données. La liste n'inclut des données d'engagement (date de la dernière ouverture de la salle par une personne, nombre d'e-mails d'invitation envoyés, date d'acceptation) que pour un jeton créé avec Lire les analyses d'engagement activé. Elle n'inclut jamais les liens de dérogation au NDA ni les identifiants d'utilisateur.

Inviter un investisseur, retirer ou rétablir son accès, modifier ses permissions, et joindre ou révoquer le NDA d'une société se font chacun en deux étapes. Le premier appel ne modifie rien : il renvoie un aperçu exact de ce qui va se passer et un confirm_token. Votre assistant vous montre l'aperçu et, seulement après votre accord, répète l'appel avec des arguments identiques plus ce confirm_token. Un jeton ne sert qu'une fois et expire au bout de quelques minutes. Si un élément de l'aperçu a changé entre-temps, le second appel est refusé et votre assistant vous redemande votre accord.

dataroom_list_investors

Liste les investisseurs invités dans votre organisation, ou dans une salle de données.

  • Portée : read. Rôle : propriétaire ou administrateur.
  • Entrées : dataroom_id (facultatif ; obligatoire pour un jeton limité à certaines salles de données) ; status (facultatif : pending, accepted, revoked ou access_requested).
  • Sortie : { investors: [{ id, email, display_name, role, status, require_nda, nda, investor_org, can_view_monitoring, can_view_updates, expires_at, invited_at }] }. L'id est l'identifiant d'invitation qu'acceptent les autres outils investisseurs. Avec Lire les analyses d'engagement, chaque ligne comporte aussi engagement: { last_seen_at, send_count, last_sent_at, accepted_at }.

dataroom_get_nda

Lit le NDA de votre organisation : le titre, le texte et les clauses de la version actuelle, ainsi que l'historique des versions. Renvoie current: null lorsque l'organisation n'a pas encore de NDA ; la lecture n'en crée jamais.

  • Portée : read. Rôle : membre de l'équipe de transaction.
  • Entrées : aucune.
  • Sortie : { current, versions, clauses, tally }. tally (nombres de NDA signés, dispensés et en attente) vaut null pour un jeton limité à certaines salles de données.

dataroom_list_firm_ndas

Liste les sociétés investisseuses de votre organisation et indique si chacune dispose d'un NDA de société en vigueur.

  • Portée : read. Rôle : membre de l'équipe de transaction. Nécessite un jeton non limité à certaines salles de données.
  • Entrées : aucune.
  • Sortie : { firms: [{ id, name, has_live_nda }] }.

dataroom_get_firm_nda

Lit le NDA d'une société avec votre organisation, ainsi que les enveloppes de signature électronique terminées que vous pourriez joindre comme NDA.

  • Portée : read. Rôle : membre de l'équipe de transaction. Nécessite un jeton non limité à certaines salles de données.
  • Entrées : investor_org_id (obligatoire).
  • Sortie : { agreement, attachable_envelopes }. agreement vaut null lorsque la société n'en a aucun.

dataroom_extend_investor_access

Prolonge l'accès d'une invitation acceptée de la durée d'expiration des liens invités de votre organisation (7 jours sauf si vous l'avez modifiée), et maintient la session actuelle de l'investisseur active pendant cette durée. Uniquement pour une invitation à une salle de données.

  • Portée : write. Rôle : membre de l'équipe de transaction. Nécessite : Envoyer à des personnes en dehors de votre organisation.
  • Entrées : invite_id (obligatoire).
  • Sortie : { invite_id, expires_at, expiry_hours }. Une invitation non acceptée est refusée avec un conflit.

dataroom_invite_investor

Invite un investisseur dans une salle de données par e-mail, le réinvite avec un nouveau rôle ou une nouvelle exigence de NDA, ou renvoie son invitation. Il reçoit un e-mail avec un lien personnel, sauf si notify vaut false. L'aperçu indique si l'opération crée, met à jour ou conserve l'invitation, lesquels de vos arguments seront ignorés (un renvoi conserve le rôle et le NDA enregistrés), le changement de statut (un investisseur retiré est rétabli), toute dérogation au NDA, et si un e-mail est envoyé. L'aperçu ne consomme rien de la limite quotidienne d'invitations ; l'envoi, si.

  • Portée : admin. Rôle : propriétaire ou administrateur, dans l'équipe de transaction de la salle de données. Nécessite : Envoyer à des personnes en dehors de votre organisation.
  • Entrées : email, dataroom_id (obligatoires) ; role (viewer ou downloader) ; require_nda ; resend ; notify ; confirm_token.
  • Sortie : l'aperçu et le confirm_token au premier appel ; puis { status: 'sent' | 'added', invite_id, link_expires_at }.

dataroom_revoke_investor_access

Retire l'accès d'un investisseur. Sa session en cours et ses autorisations sur les fichiers et dossiers dans la salle de données de l'invitation prennent fin. Un rétablissement ultérieur restaure l'accès à la salle, pas les autorisations sur les fichiers.

  • Portée : admin. Rôle : propriétaire ou administrateur.
  • Entrées : invite_id (obligatoire) ; confirm_token.
  • Sortie : l'aperçu et le confirm_token ; puis { status: 'revoked', invite_id }.

dataroom_reinstate_investor_access

Rétablit un investisseur retiré, ou approuve une demande d'accès. Accès à la salle uniquement.

  • Portée : admin. Rôle : propriétaire ou administrateur. Nécessite : Envoyer à des personnes en dehors de votre organisation.
  • Entrées : invite_id (obligatoire) ; confirm_token.
  • Sortie : l'aperçu et le confirm_token ; puis { status: 'reinstated', invite_id }.

dataroom_set_investor_permissions

Modifie le rôle d'une invitation, l'exigence de NDA, ainsi que l'accès au suivi et aux mises à jour. L'aperçu liste chaque modification. Désactiver le NDA enregistre une dérogation en votre nom, avec un motif et un lien facultatifs.

  • Portée : admin. Rôle : propriétaire ou administrateur.
  • Entrées : invite_id (obligatoire) ; au moins l'un de role, require_nda, can_view_monitoring, can_view_updates ; nda_waiver_reason ; nda_waiver_url ; confirm_token.
  • Sortie : l'aperçu et le confirm_token ; puis { status: 'updated', invite_id, changes }.

dataroom_attach_firm_nda

Enregistre une enveloppe de signature électronique terminée comme NDA signé d'une société investisseuse, avec sa date de signature et sa durée. Toute enveloppe que vous pouvez voir peut être jointe.

  • Portée : admin. Rôle : propriétaire ou administrateur. Nécessite un jeton non limité à certaines salles de données.
  • Entrées : investor_org_id, envelope_id, executed_at, term (obligatoires) ; confirm_token.
  • Sortie : l'aperçu et le confirm_token ; puis { status: 'attached', agreement }.

dataroom_revoke_firm_nda

Révoque le NDA d'une société investisseuse. Pour un NDA initié sur Waafir et encore en attente de signature, l'enveloppe est également annulée.

  • Portée : admin. Rôle : propriétaire ou administrateur. Nécessite un jeton non limité à certaines salles de données.
  • Entrées : investor_org_id (obligatoire) ; reason ; confirm_token.
  • Sortie : l'aperçu et le confirm_token ; puis { status: 'revoked', investor_org_id, envelope_voided }.

Outils de sociétés investisseuses

Outils portant sur vos sociétés investisseuses : les groupes auxquels appartiennent vos investisseurs, comme sur la page Investisseurs. Chacun nécessite un rôle de propriétaire ou d'administrateur dans votre organisation, vérifié à chaque appel, et un jeton qui n'est pas limité à certaines salles de données. Une société inconnue, une société d'une autre organisation et une société absorbée par une fusion reçoivent toutes la même réponse « introuvable ».

Placer une personne dans une société et fusionner deux sociétés se font chacun en deux étapes, comme les outils investisseurs ci-dessus. Les deux peuvent faire sortir une personne de sa société actuelle. Si la société qu'elle rejoint dispose d'un NDA signé, celui-ci la couvre dès lors, et ses invitations en attente qui exigent un NDA cessent de l'exiger. Lorsque l'aperçu liste une telle invitation, le jeton nécessite aussi Envoyer à des personnes en dehors de votre organisation. Retirer une personne d'une société n'est pas possible ici.

dataroom_list_investor_firms

Liste les sociétés investisseuses de votre organisation avec leur domaine, leur nombre de membres, la note privée de l'équipe de transaction et le statut du NDA de la société.

  • Portée : read. Rôle : propriétaire ou administrateur.
  • Entrées : aucune.
  • Sortie : { investor_firms: [{ id, name, canonical_domain, member_count, deal_team_note, firm_nda }] }. deal_team_note est marqué comme texte rédigé par un collègue.

dataroom_create_investor_firm

Crée une société investisseuse. Avec member_emails et canonical_domain, chaque personne listée sur ce domaine qui est déjà invitée dans l'une de vos salles de données et n'appartient encore à aucune société en devient membre. Personne n'est retiré d'une autre société.

  • Portée : admin. Rôle : propriétaire ou administrateur.
  • Entrées : name (obligatoire) ; canonical_domain ; member_emails (jusqu'à 500, nécessite canonical_domain).
  • Sortie : { status: 'created', investor_firm: { id, name }, added }.

dataroom_rename_investor_firm

Renomme une société investisseuse.

  • Portée : admin. Rôle : propriétaire ou administrateur.
  • Entrées : investor_org_id, name (obligatoires).
  • Sortie : { status: 'renamed' | 'unchanged', investor_org_id, name }.

dataroom_set_investor_firm_note

Définit ou efface la note privée de l'équipe de transaction sur une société. Les investisseurs ne la voient jamais.

  • Portée : admin. Rôle : propriétaire ou administrateur.
  • Entrées : investor_org_id, note (obligatoires ; une chaîne vide l'efface).
  • Sortie : { status: 'set' | 'cleared' | 'unchanged', investor_org_id, cleared }.

dataroom_assign_investor_to_firm

Place un investisseur, identifié par son e-mail, dans une société, en le faisant sortir de sa société actuelle s'il en a une. L'aperçu nomme la société qu'il quitte et les invitations en attente dont l'étape NDA serait désormais satisfaite par le NDA de la société. Une personne déjà membre de la société est laissée telle quelle, sans étape de confirmation.

  • Portée : admin. Rôle : propriétaire ou administrateur. Nécessite : Envoyer à des personnes en dehors de votre organisation lorsque l'aperçu liste une invitation.
  • Entrées : investor_org_id, email (obligatoires) ; confirm_token.
  • Sortie : l'aperçu et le confirm_token ; puis { status: 'assigned', investor_org_id, email, moved_from, coverage_started }.

dataroom_merge_investor_firms

Fusionne une société dans une autre. Chaque membre de la société source rejoint la société cible, et la société source disparaît de votre liste de sociétés. Vous ne pouvez pas annuler une fusion depuis votre assistant ni depuis l'application. L'aperçu liste les personnes déplacées et les invitations en attente dont l'étape NDA serait désormais satisfaite par le NDA de la société cible.

  • Portée : admin. Rôle : propriétaire ou administrateur. Nécessite : Envoyer à des personnes en dehors de votre organisation lorsque l'aperçu liste une invitation.
  • Entrées : source_investor_org_id, target_investor_org_id (obligatoires, et différents) ; confirm_token.
  • Sortie : l'aperçu et le confirm_token ; puis { status: 'merged', source_investor_org_id, target_investor_org_id, moved_count, coverage_started_count }.

Outils d'engagement

Outils en lecture seule indiquant qui a lu quoi, quand et pendant combien de temps. Il s'agit de données comportementales sur des personnes nommées : chacun nécessite donc un jeton créé avec Lire les analyses d'engagement activé, ainsi qu'un rôle dans l'équipe de transaction. Chacun ne comptabilise que les documents que le propriétaire du jeton peut lui-même lire. Les outils de salle acceptent le même filtre que la page d'engagement : range (ou from et to), people, firm_ids, folder_id et tz.

dataroom_get_activity_trail

Le journal d'accès de votre organisation, du plus récent au plus ancien. Nécessite un jeton non limité à certaines salles de données.

  • Portée : read. Entrées : counterparty, since, cursor, limit.

dataroom_get_room_engagement

Le tableau de scores, la carte de chaleur et la chronologie d'une salle de données, avec ses synthèses par transaction.

  • Portée : read. Entrées : dataroom_id (obligatoire) et le filtre.

dataroom_get_engagement_scores

Le score d'engagement de chaque investisseur dans une salle de données, classé.

  • Portée : read. Entrées : dataroom_id (obligatoire) et le filtre.

dataroom_get_investor_engagement

Les visites d'un investisseur et les documents qu'il a ouverts dans une salle de données. La consultation est enregistrée dans votre journal d'audit, comme dans Waafir.

  • Portée : read. Entrées : dataroom_id, email (obligatoires) et le filtre.

dataroom_get_document_engagement

La lecture par document et par contrepartie dans l'ensemble de votre organisation, et, avec file_id, le temps passé par page sur ce document. Nécessite un jeton non limité à certaines salles de données.

  • Portée : read. Entrées : counterparty, file_id, weeks, cursor, limit, page_range.

dataroom_get_firm_rollups

L'activité hebdomadaire par contrepartie dans l'ensemble de votre organisation. Nécessite un jeton non limité à certaines salles de données.

  • Portée : read. Entrées : counterparty, weeks, cursor, limit.

Outils de Q&R

Deux outils en lecture seule portant sur les fils de Q&R des investisseurs dans une salle de données. Un jeton de l'équipe de transaction ne peut pas publier de question ici ; l'agent propre d'un investisseur pose ses questions avec dataroom_ask_question (voir Outils de l'agent investisseur).

Ce que renvoie un appel dépend de la personne à qui appartient le jeton :

  • un membre de l'équipe de transaction voit tous les fils de la salle de données, y compris l'adresse e-mail de la personne qui a posé la question ;
  • un investisseur ne voit que les questions qu'il a lui-même posées, et aucune adresse e-mail.

Les documents joints sont renvoyés sous forme d'identifiant et de nom uniquement — jamais leur contenu, jamais un lien de téléchargement — et le nom d'un document que l'appelant n'est pas autorisé à voir est masqué. Utilisez les outils de documents pour le contenu ; ils appliquent leurs propres contrôles d'accès. Les questions de Q&R de l'entreprise à l'échelle de l'organisation, qui ne sont pas rattachées à une salle de données, ne sont jamais renvoyées par l'un ou l'autre outil.

dataroom_list_questions

Nom sur l'endpoint de domaine : list_questions

Liste les fils de Q&R d'une salle de données autorisée, du plus récent au plus ancien, chacun avec ses réponses.

  • Portée : read.
  • Entrées : dataroom_id (obligatoire) ; status (facultatif — open, answered ou closed) ; file_id (facultatif — uniquement les questions posées sur ce document) ; limit (facultatif, 1–100, 25 par défaut) ; offset (facultatif, 0 par défaut).
  • Sortie : { questions, pagination }. Paginez avec offset tant que pagination.has_more vaut true.

dataroom_get_question

Nom sur l'endpoint de domaine : get_question

Obtient un fil de Q&R par son identifiant, avec toutes ses réponses.

  • Portée : read.
  • Entrées : dataroom_id (obligatoire) ; question_id (obligatoire).
  • Sortie : { question }.
  • Une question d'une autre salle de données ou d'une autre organisation — ou, pour un investisseur, une question posée par quelqu'un d'autre — renvoie NOT_FOUND. L'outil ne confirme jamais l'existence d'un tel identifiant.

Chaque question comporte { id, dataroom_id, title, body, question_type, status, asked_by, file_id, file_name, created_at, updated_at, responses }, plus asker_email uniquement lorsque l'appelant y a droit — pour un investisseur, la clé est absente de la charge utile plutôt que présente et nulle. Chaque entrée de responses vaut { id, body, responded_by, is_ai_draft, created_at, updated_at, attachments }.

dataroom_answer_question (écriture)

Répond à la question d'un investisseur. Il n'y a pas de brouillon : l'investisseur voit la réponse immédiatement, et la personne qui a posé la question est avertie par e-mail si ses paramètres le permettent. Ni l'un ni l'autre ne peut être rappelé.

  • Portée : write. Membres de l'équipe de transaction de la salle de données.
  • Autorisation : le jeton nécessite Envoyer à des personnes en dehors de votre organisation.
  • Entrées : dataroom_id, question_id, body (tous obligatoires) ; confirm_token.
  • En deux étapes. Sans confirm_token, rien n'est publié et vous obtenez un aperçu (la question, le nombre de réponses qu'elle a déjà, si la personne qui l'a posée sera avertie par e-mail) plus un jeton. Appelez de nouveau avec les mêmes arguments et le jeton pour publier. Une nouvelle réponse ou un fil fermé entre-temps fait échouer l'appel, et vous refaites un aperçu.

dataroom_close_question (écriture)

Ferme un fil de Q&R. La personne qui a posé la question, ou un administrateur ou gestionnaire de l'organisation, peut le fermer.

  • Portée : write.
  • Entrées : dataroom_id, question_id (tous deux obligatoires).
  • Sortie : { question_id, outcome, kb_draft, kb_draft_skip_reason }.
  • Lorsque l'organisation paie pour l'IA et l'a activée, la fermeture d'un fil comportant des réponses met aussi en file d'attente un brouillon pour la base de connaissances. Sinon, kb_draft vaut skipped et le motif en indique la raison. Rien n'est envoyé à l'investisseur.

dataroom_bulk_close_questions (écriture)

Ferme jusqu'à 100 fils d'une salle de données. Chacun est évalué individuellement.

  • Portée : write.
  • Entrées : dataroom_id, question_ids (tous deux obligatoires).
  • Sortie : { requested, closed, results }. L'outcome de chaque résultat vaut closed, not_found, forbidden ou already_closed.

dataroom_edit_question (écriture)

Modifie le titre et/ou le corps d'une question. Administrateurs et gestionnaires uniquement.

  • Portée : write.
  • Entrées : dataroom_id, question_id (tous deux obligatoires) ; title, body (au moins l'un des deux).
  • Sortie : { question_id, title, body }.

dataroom_edit_answer (écriture)

Modifie le texte d'une réponse. Administrateurs et gestionnaires uniquement. L'investisseur voit la modification immédiatement, comme dans Waafir ; aucun nouvel e-mail n'est envoyé.

  • Portée : write.
  • Entrées : dataroom_id, question_id, response_id, body (tous obligatoires).
  • Sortie : { response_id, question_id, body }.

dataroom_delete_question (écriture)

Supprime un fil de Q&R. Les investisseurs cessent de le voir, ainsi que ses réponses. Administrateurs et gestionnaires uniquement.

  • Portée : write.
  • Entrées : dataroom_id, question_id (tous deux obligatoires) ; confirm_token.
  • En deux étapes. Sans confirm_token, rien n'est supprimé et vous obtenez un aperçu plus un jeton. Appelez de nouveau avec les mêmes arguments et le jeton pour supprimer. Un jeton ne sert qu'une fois et expire au bout de quelques minutes.

dataroom_delete_answer (écriture)

Supprime une réponse d'un fil. L'investisseur cesse de la voir. Administrateurs et gestionnaires uniquement.

  • Portée : write.
  • Entrées : dataroom_id, question_id, response_id (tous obligatoires) ; confirm_token.
  • En deux étapes, comme pour dataroom_delete_question.

dataroom_publish_kb_article (écriture)

Publie un article de la base de connaissances, par exemple un brouillon issu d'un fil fermé. Les investisseurs qui peuvent voir la salle de données peuvent alors le lire. Administrateurs et gestionnaires uniquement.

  • Portée : write.
  • Entrées : dataroom_id, article_id (tous deux obligatoires) ; confirm_token.
  • En deux étapes, comme pour dataroom_delete_question.

Outils de mises à jour investisseurs

Ces outils reproduisent l'éditeur de mises à jour investisseurs de Waafir, avec les mêmes contrôles de rôle. Chacun nécessite le module complémentaire Documents pour investisseurs sur la salle de données. Aucun n'envoie quoi que ce soit aux investisseurs : la publication se fait dans Waafir.

dataroom_list_updates

Liste les mises à jour investisseurs d'une salle de données, quel que soit leur statut, de la modification la plus récente à la plus ancienne.

  • Portée : read. Membres de l'équipe de transaction de la salle de données.
  • Entrées : dataroom_id (obligatoire).
  • Sortie : { updates }, chacune { id, title, period_label, status, version, published_at, updated_at }.

dataroom_create_update (écriture)

Crée une mise à jour en brouillon à partir de portefeuilles et/ou de fichiers (au moins un).

  • Portée : write. Membres de l'équipe de transaction de la salle de données.
  • Entrées : dataroom_id, period_label (tous deux obligatoires) ; title, period_start, period_end, tone_notes, portfolio_ids, file_ids.
  • Sortie : { update_id, status, portfolio_count, file_count }. Les fichiers et portefeuilles n'appartenant pas à votre organisation sont écartés et non comptés.

dataroom_get_update

Lit une mise à jour telle que l'affiche l'éditeur.

  • Portée : read. Propriétaires et administrateurs.
  • Entrées : dataroom_id, update_id (tous deux obligatoires).
  • Sortie : { update_id, status, document, latest_generation }. document est le dernier brouillon généré avec vos modifications appliquées, ou null avant la première génération.

dataroom_get_update_generation

Le statut d'une exécution de génération.

  • Portée : read. Propriétaires et administrateurs.
  • Entrées : dataroom_id, update_id, generation_id (tous obligatoires).
  • Sortie : { generation_id, status, error_code }. Une exécution en échec donne son code, jamais le message stocké.

dataroom_generate_update (écriture)

Lance une génération par IA d'une mise à jour en brouillon ou en révision.

  • Portée : write, plus l'autorisation Lire le contenu des documents sur le jeton : l'exécution lit les fichiers sélectionnés en intégralité, guidée par les notes de ton de la mise à jour. Propriétaires et administrateurs.
  • Entrées : dataroom_id, update_id (tous deux obligatoires).
  • Sortie : { generation_id, queued }. Interrogez dataroom_get_update_generation.
  • Nécessite une offre payante et des fonctionnalités d'IA activées, et est décompté de la limite quotidienne d'IA. Partage la limite de l'éditeur de 5 générations par minute.

dataroom_edit_update_draft (écriture)

Enregistre vos modifications par-dessus le contenu généré d'un brouillon, comme le fait l'éditeur.

  • Portée : write. Propriétaires et administrateurs.
  • Entrées : dataroom_id, update_id, overrides (tous obligatoires). overrides accepte narrative_sections, chart_placements et citations.
  • Sortie : { update_id, status, document }. Seul un brouillon peut être modifié.

dataroom_submit_update_for_review (écriture)

Fait passer une mise à jour en brouillon au statut in_review.

  • Portée : write. Administrateurs et gestionnaires.
  • Entrées : dataroom_id, update_id (tous deux obligatoires).
  • Sortie : { update_id, status }.
  • La mise à jour doit comporter du contenu généré et aucune génération ne doit être en cours.

dataroom_publish_update (écriture)

Publie une mise à jour en révision. Les investisseurs de la salle de données peuvent la voir immédiatement et chacun est averti par e-mail, ce qui ne peut pas être rappelé.

  • Portée : write. Administrateurs et gestionnaires.
  • Autorisation : le jeton nécessite Envoyer à des personnes en dehors de votre organisation.
  • Entrées : dataroom_id, update_id (tous deux obligatoires) ; confirm_token.
  • En deux étapes. Sans confirm_token, rien n'est publié et vous obtenez un aperçu (la mise à jour et le nombre d'investisseurs qui seront avertis par e-mail) plus un jeton. Appelez de nouveau avec les mêmes arguments et le jeton pour publier. Si la mise à jour ou sa liste d'investisseurs a changé entre-temps, l'appel est refusé et vous refaites un aperçu.

dataroom_republish_update (écriture)

Copie une mise à jour publiée dans une nouvelle version en brouillon que vous modifiez, faites réviser et publiez ensuite. La version publiée reste en ligne d'ici là.

  • Portée : write. Administrateurs et gestionnaires.
  • Entrées : dataroom_id, update_id (tous deux obligatoires).
  • Sortie : { update_id, status, version } du nouveau brouillon.

Outils Intelligence de marché

En lecture seule. Ils nécessitent le module complémentaire Intelligence de marché (un aperçu fonctionne, avec ses limites), un jeton qui n'est pas limité à certaines salles de données, et un membre de l'équipe de transaction comme propriétaire.

mi_get_subject

L'entreprise de votre organisation dans le module Intelligence de marché.

  • Portée : read.
  • Entrées : aucune.
  • Sortie : { subject, access }. subject vaut { id, name }, ou null tant que personne n'a ouvert le module Intelligence de marché dans Waafir.

mi_get_profile

Le profil d'une entreprise : la version confirmée et le brouillon de travail.

  • Portée : read.
  • Entrées : subject_id (obligatoire).
  • Sortie : { subject, confirmed, draft, file_names }. Chaque champ vaut stated (avec le file_id et la page d'où il a été lu, ou une page web publique et sa citation), entered, not_applicable, ou null.
  • Les citations issues des documents de la salle de données ne sont pas renvoyées. Lisez le fichier avec les outils de documents si vous en avez besoin.

mi_list_matches

Les investisseurs classés pour le profil de l'entreprise, du meilleur au moins bon.

  • Portée : read.
  • Entrées : subject_id (obligatoire).
  • Sortie : { profile_version, preliminary, similarity, live, country, caveat, total, matches }. Chaque correspondance vaut { entity_id, name, score, penalties, reasons, contacts_available, on_roster, addable }.
  • Un aperçu affiche les 3 premiers. Le classement par similarité n'est utilisé que lorsque votre offre inclut l'IA, que l'IA est activée et que la limite quotidienne d'IA le permet ; similarity indique ce qu'il en est.
  • Les coordonnées ne sont jamais renvoyées. L'outil partage la limite de la page Waafir de 30 par minute.

Outils d'IA

Ces outils effectuent le travail d'IA du côté de Waafir et remettent à votre client d'IA le résultat : une réponse avec citations, un résumé, une revue, un plan de dossiers proposé ou un brouillon. Votre client n'a jamais besoin de télécharger les documents pour y parvenir. Ils nécessitent le module complémentaire d'IA, sont décomptés du budget quotidien d'IA de votre organisation, et sont suspendus lorsque vos administrateurs suspendent l'IA. Chacun est limité, par personne, au même rythme que le bouton correspondant dans l'application, et enregistre ce qu'il a renvoyé dans le journal d'activité.

Une réponse peut reprendre le contenu d'un document lorsque c'est votre client qui rédige la question : dataroom_ask, dataroom_draft_answer et dataroom_compare_files nécessitent donc l'autorisation Lire le contenu des documents sur le jeton, comme dataroom_get_file_text. Sans elle, ils ne sont pas listés, et un appel est refusé avec GRANT_REQUIRED. Les autres outils d'IA exécutent une tâche prédéfinie sur la salle et fonctionnent sans elle. Chaque résultat marque les champs qui contiennent une sortie d'IA dans untrusted_content (voir Texte non fiable dans les résultats).

Seuls les documents que le propriétaire du jeton peut ouvrir sont utilisés ou cités. Les outils fonctionnent dans les salles de données de l'organisation du jeton.

dataroom_ask

Pose une question sur une salle de données et obtient une réponse fondée sur les documents.

  • Portée : read, plus l'autorisation Lire le contenu des documents sur le jeton. Tout membre de la salle de données.
  • Entrées : dataroom_id (obligatoire) ; question (obligatoire).
  • Sortie : { dataroom_id, answer, citations }. Jusqu'à 10 citations, chacune { source_type, id, title, page? }. Aucun texte de document n'est renvoyé, et aucune conversation de chat n'est enregistrée.

dataroom_summarise_file

Obtient le résumé IA et les points clés d'un fichier.

  • Portée : read. Équipe de transaction, avec un accès en téléchargement au fichier.
  • Entrées : dataroom_id (obligatoire) ; file_id (obligatoire).
  • Sortie : { file_id, file_name, status: "ready", summary, key_points }, ou status: "queued" lorsque le fichier n'a pas encore de résumé. Le résumé démarre alors en arrière-plan, comme avec le bouton Résumer ; rappelez plus tard.

dataroom_list_facts

Liste les faits vérifiés et les termes clés extraits des documents d'une salle de données.

  • Portée : read. Équipe de transaction.
  • Entrées : dataroom_id (obligatoire) ; file_id (facultatif) ; types (facultatif) ; limit (facultatif, 1–200, 50 par défaut) ; cursor (facultatif).
  • Sortie : { dataroom_id, facts, has_more, next_cursor }. Chaque fait vaut { id, file_id, file_name, fact_type, value, page, confidence, created_at }. Tant que has_more vaut true, retransmettez next_cursor comme cursor pour la page suivante.
  • Sans l'autorisation Lire le contenu des documents sur le jeton, la value de chaque fait conserve au plus 20 mots (160 caractères), comptés sur l'ensemble de la valeur, et le fait comporte value_truncated.

dataroom_compare_files

Compare deux fichiers d'une salle de données et obtient les différences significatives.

  • Portée : read, plus l'autorisation Lire le contenu des documents sur le jeton. Équipe de transaction, avec un accès en téléchargement aux deux fichiers.
  • Entrées : dataroom_id (obligatoire) ; file_id_a (obligatoire) ; file_id_b (obligatoire).
  • Sortie : { dataroom_id, file_a, file_b, differences }. Chaque entrée de fichier vaut { id, name, truncated } : un document très long est comparé sur sa première partie, et truncated le signale. Aucun texte de document n'est renvoyé.
  • Un fichier d'un type ne comportant aucun texte à extraire est refusé avec un 400, et un fichier stocké de plus de 50 Mo avec un 413 (FILE_TOO_LARGE), avant que l'un ou l'autre ne soit récupéré, lorsque le texte du fichier n'a pas déjà été extrait.

dataroom_review

Exécute la revue de préparation par IA d'une salle de données.

  • Portée : read. Équipe de transaction.
  • Entrées : dataroom_id (obligatoire) ; force_refresh (facultatif).
  • Sortie : { dataroom_id, cached, readinessScore, presentDocs, missingDocs, flaggedForRedaction, flaggedForRename, flaggedOutOfDate, suggestions }. Une revue stockée à jour est renvoyée sans nouvelle exécution de l'IA, sauf si force_refresh vaut true.

dataroom_propose_organise (écriture)

Étape 1 sur 2 : propose une structure de dossiers pour une salle de données. Rien n'est déplacé.

  • Portée : write. Propriétaire ou administrateur.
  • Entrées : dataroom_id (obligatoire).
  • Sortie : { dataroom_id, suggestion_id, applied: false, proposed_folders, unchanged_file_ids, files, total_files, accounted_for }.

dataroom_apply_organise (écriture)

Étape 2 sur 2 : applique une proposition par son suggestion_id. C'est exactement la proposition stockée qui est appliquée, une seule fois ; elle ne peut pas être modifiée en cours de route. Les fichiers que le propriétaire du jeton n'est pas autorisé à déplacer sont ignorés et comptés. Pour annuler, utilisez le panneau Organiser dans l'application.

  • Portée : write. Propriétaire ou administrateur.
  • Entrées : dataroom_id (obligatoire) ; suggestion_id (obligatoire).
  • Sortie : { dataroom_id, suggestion_id, folders_created, files_moved, files_skipped }.

dataroom_draft_answer

Rédige un brouillon de réponse à une question d'investisseur à partir des documents de la salle de données.

  • Portée : read, plus l'autorisation Lire le contenu des documents sur le jeton. Propriétaire ou administrateur.
  • Entrées : question_id (obligatoire).
  • Sortie : { question_id, draft, is_draft: true, sources }. Le brouillon vous est renvoyé à vous seul : rien n'est enregistré, envoyé ni publié. C'est une personne qui publie la réponse dans l'application. Les questions au niveau de l'organisation sont rédigées dans l'application.

Outils de préparation et de base de connaissances

En lecture seule. La préparation renvoie le score et les décomptes qui le sous-tendent, jamais le texte de la revue ; exécutez dataroom_review pour l'obtenir.

dataroom_get_readiness_score

Le score de préparation d'une salle de données.

  • Portée : read, et le propriétaire du jeton doit être propriétaire ou administrateur de l'organisation.
  • Entrées : dataroom_id (obligatoire).
  • Sortie : { dataroom_id, score, reviewed, questions_total, questions_answered, kb_articles, files_uploaded, present_categories, missing_categories }. score va de 0 à 100, ou vaut null lorsqu'il n'existe aucune revue par IA qui puisse vous être montrée.

dataroom_get_readiness_rollup

La préparation de l'ensemble des salles de données de l'organisation, telle que l'affiche le tableau de bord.

  • Portée : read, et le propriétaire du jeton doit faire partie de l'équipe de transaction. Un jeton limité à des salles de données précises est refusé.
  • Entrées : aucune.
  • Sortie : { rooms: [{ id, name, investors, reading, updated, status, readinessPct, tone, reviewedAt, presentCount, missingCount, categories }] }. Les décomptes de documents par catégorie n'incluent que les documents que le propriétaire du jeton peut lire.

dataroom_list_kb_articles

Liste les articles de la base de connaissances d'une salle, les siens et ceux de l'ensemble de l'organisation.

  • Portée : read.
  • Entrées : dataroom_id (obligatoire) ; category ; include_drafts (équipe de transaction uniquement).
  • Sortie : { articles: [{ id, title, category, published }] }.
  • Une personne admise dans la salle uniquement via un document partagé ne voit aucun article. Un jeton d'investisseur ne voit que les articles publiés.

dataroom_get_kb_article

Lit un article.

  • Portée : read.
  • Entrées : dataroom_id, article_id (obligatoires).
  • Sortie : { id, title, category, body, published, updated_at }. Un brouillon est traité comme introuvable, sauf si le propriétaire du jeton fait partie de l'équipe de transaction.

Outils de l'agent investisseur

Outils destinés à l'agent propre d'un investisseur : ils ne fonctionnent qu'avec un jeton d'accès investisseur, et un jeton de l'équipe de transaction ne peut ni les lister ni les appeler.

Un jeton investisseur peut aussi appeler ces outils partagés. Chacun ne répond qu'avec ce que l'investisseur voit dans la salle de données.

  • Salles et fichiers : dataroom_list, dataroom_get, dataroom_list_folders, dataroom_list_files, dataroom_get_file_metadata et dataroom_search.
  • Instantanés : dataroom_list_snapshots et dataroom_get_snapshot, pour les instantanés que l'investisseur consulte.
  • Téléchargements : dataroom_get_file_download_url. La copie est toujours filigranée avec l'identité de l'investisseur, comme l'est son téléchargement dans le navigateur.
  • Q&R et articles : dataroom_list_questions, dataroom_get_question, dataroom_list_kb_articles et dataroom_get_kb_article. Ces outils renvoient les propres questions de l'investisseur et les articles publiés.
  • IA : dataroom_ask, dataroom_compare_files, translate_text, translate_file et translate_file_status. Les traductions d'un investisseur lui sont privées.

dataroom_get_file_text est refusé à un jeton investisseur : du texte brut ne peut pas porter de filigrane, l'agent utilise donc le téléchargement filigrané à la place.

Qui paie l'IA. Chaque appel d'IA coûte des unités de quota. L'organisation de la salle paie jusqu'à un quota mensuel par investisseur et par salle (mois UTC). L'équipe de transaction fixe le quota par salle, et la valeur par défaut est de 200 unités. Au-delà du quota, c'est une organisation dont l'investisseur est membre qui paie, si elle dispose d'un abonnement actif et de l'IA activée (d'abord les organisations dont l'investisseur est propriétaire, puis la plus ancienne). À défaut des deux, l'appel est refusé avant tout travail du modèle avec QUOTA_EXCEEDED (HTTP 402). Le message indique la date de réinitialisation du quota.

Limite de débit. Les agents d'un investisseur partagent une limite unique de 60 appels par minute, sur l'ensemble des jetons et connexions de cet investisseur. Au-delà, l'appel est refusé (HTTP 429) avec le délai à attendre avant de réessayer.

Chaque outil vérifie ce que la salle de données vérifie pour l'investisseur : accès non expiré ni révoqué, NDA accepté, interrupteur d'agent par salle de l'équipe de transaction activé et, pour un fichier, l'accès en lecture de l'investisseur à ce fichier. Un fichier qu'il ne peut pas lire est signalé comme introuvable, et son nom n'est jamais renvoyé. L'acceptation d'un NDA se fait dans la salle de données.

dataroom_ask_question (écriture)

Pose une question à l'équipe de transaction dans une salle de données. Seuls l'investisseur et l'équipe de transaction la voient ; l'équipe de transaction est notifiée.

  • Portée : write.
  • Entrées : dataroom_id, title (au moins 5 caractères) (obligatoires) ; description, category, file_id (un fichier que l'investisseur peut lire).
  • Sortie : { question_id, dataroom_id, file_id, status }.

dataroom_list_file_comments

Les commentaires que l'investisseur peut voir sur un fichier : les siens, avec les réponses.

  • Portée : read.
  • Entrées : dataroom_id, file_id (obligatoires).
  • Sortie : { comments: [{ id, content, page, resolved, created_at, author, replies }] }.

dataroom_add_file_comment (écriture)

Commente un fichier que l'investisseur peut lire. Visible par l'investisseur et l'équipe de transaction, jamais par les autres investisseurs.

  • Portée : write.
  • Entrées : dataroom_id, file_id, content (obligatoires) ; page.
  • Sortie : { comment_id, file_id, created_at }.

dataroom_reply_file_comment (écriture)

Répond à un commentaire que l'investisseur peut voir. Un commentaire sur un autre fichier est signalé comme introuvable.

  • Portée : write.
  • Entrées : dataroom_id, file_id, comment_id, content (obligatoires).
  • Sortie : { reply_id, comment_id, created_at }.

dataroom_get_my_nda_status

La situation de l'investisseur au regard du NDA dans chaque salle que son agent peut atteindre.

  • Portée : read.
  • Entrées : aucune.
  • Sortie : { rooms: [{ dataroom_id, dataroom_name, basis, accepted, accepted_at, version, accept_step }] }. basis vaut org_standard, firm_executed, firm_in_progress, waived ou not_required ; accept_step vaut clickthrough, held ou none.

dataroom_list_my_notifications

Les notifications de l'investisseur provenant de l'organisation du jeton : invitations, réponses à ses questions et modifications de son accès aux dossiers.

  • Portée : read.
  • Entrées : unread_only ; limit (1–50, 20 par défaut) ; offset.
  • Sortie : { notifications: [{ id, type, title, body, resource_type, resource_id, read, created_at }], unread_count, pagination }.

dataroom_mark_notifications_read (écriture)

Marque des notifications comme lues : les identifiants listés, ou toutes avec all: true.

  • Portée : write.
  • Entrées : ids (1–100) ou all.
  • Sortie : { marked }, le nombre de notifications modifiées.

dataroom_list_published_updates

Les mises à jour investisseurs publiées à l'intention de l'investisseur dans une salle.

  • Portée : read.
  • Entrées : dataroom_id (obligatoire).
  • Sortie : { updates: [{ id, title, period_label, version, published_at, unread }] }.
  • Refusé lorsque l'équipe de transaction a désactivé les mises à jour pour l'investisseur, et lorsque la salle ne dispose pas du module complémentaire Documents pour investisseurs.

dataroom_get_published_update

Lit une mise à jour publiée.

  • Portée : read.
  • Entrées : dataroom_id, update_id (obligatoires).
  • Sortie : { update_id, title, period_label, version, published_at, document }.

Outils d'instantanés

Un instantané est une copie figée des dossiers et des versions de fichiers d'une salle, conservée pour une piste d'audit. Aucun outil ne renvoie le contenu d'un fichier ni un lien de téléchargement ; les téléchargements restent dans l'application. dataroom_get_snapshot et les outils de lecteurs refusent un jeton limité à des salles de données précises, comme le font leurs routes dans l'application.

dataroom_list_snapshots

  • Portée : read. L'équipe de transaction voit tous les instantanés ; toute autre personne ne voit que ceux auxquels elle a été ajoutée en tant que lecteur.
  • Entrées : dataroom_id (obligatoire).
  • Sortie : { snapshots: [{ id, name, purpose, snapshot_at, file_count, folder_count, viewer_count? }] }.

dataroom_get_snapshot

  • Portée : read, et un accès à l'instantané.
  • Entrées : snapshot_id (obligatoire).
  • Sortie : { snapshot, folders: [{ folder_id, parent_folder_id, name }], files: [{ file_id, folder_id, name, size_bytes, mime_type, can_download }], can_manage_viewers }. Les fichiers et dossiers que le propriétaire du jeton n'est pas autorisé à voir aujourd'hui sont écartés, et les décomptes correspondent à ce qui est listé.

dataroom_create_snapshot

Fige la salle dans son état actuel. Rien ne change dans la salle.

  • Portée : write, équipe de transaction uniquement.
  • Entrées : dataroom_id, name (obligatoires) ; purpose, notes.
  • Sortie : { snapshot: { id, name, purpose, snapshot_at, file_count, folder_count, viewer_count } }.

dataroom_list_snapshot_viewers

  • Portée : read, équipe de transaction uniquement.
  • Entrées : snapshot_id (obligatoire).
  • Sortie : { viewers: [{ viewer_id, email, granted_at, revoked_at, active }] }.

dataroom_grant_snapshot_viewer

Permet à une personne d'ouvrir un instantané, à partir de son adresse e-mail. En deux étapes : l'aperçu nomme l'instantané et l'adresse. Aucun e-mail n'est envoyé : prévenez la personne vous-même.

  • Portée : write, équipe de transaction uniquement, plus l'autorisation Envoyer à des personnes en dehors de votre organisation.
  • Entrées : snapshot_id, email (obligatoires) ; confirm_token.
  • Sortie : { viewer_id, email, active }.

dataroom_revoke_snapshot_viewer

En deux étapes.

  • Portée : write, équipe de transaction uniquement.
  • Entrées : snapshot_id, viewer_id (obligatoires) ; confirm_token.
  • Sortie : { success: true, viewer_id }.

Outils de liens de partage

Un lien de partage donne accès à une salle ou à un document à quiconque le détient : en créer un nécessite donc toujours deux étapes et un jeton disposant de l'autorisation Envoyer à des personnes en dehors de votre organisation. Aucun outil ne liste l'URL d'un lien.

  • Portée : read, et le propriétaire du jeton doit être propriétaire ou administrateur de l'organisation.
  • Entrées : dataroom_id (obligatoire) ; file_id pour les liens actifs d'un document.
  • Sortie : { links: [{ id, kind, file_id?, mode, active, expires_at, has_password, require_nda, domain_allow_list, created_at, admitted_count? }] }.
  • Les liens propres à chaque investisseur ne sont pas listés ; voir les outils investisseurs.

En deux étapes. L'aperçu indique ce qui est partagé, qui peut y accéder, la règle de NDA, la date d'expiration et la manière dont les téléchargements sont filigranés. La confirmation doit reprendre les mêmes arguments ; si la liste des investisseurs change entre-temps, confirmez de nouveau.

  • Portée : write, propriétaire ou administrateur de l'organisation, plus l'autorisation Envoyer à des personnes en dehors de votre organisation.
  • Entrées : dataroom_id, mode (open ou restricted) (obligatoires) ; file_id ; expires_in_hours ; domain_allow_list ; require_nda (true par défaut) ; confirm_token.
  • Sortie : { id, url, mode, active, expires_at, require_nda, file_id }.
  • Un document restreint ne peut pas être partagé par lien. Il n'existe pas d'option de mot de passe.

En deux étapes. Toutes les personnes qui utilisent le lien perdent immédiatement l'accès.

  • Portée : write, propriétaire ou administrateur de l'organisation.
  • Entrées : dataroom_id, link_id (obligatoires) ; confirm_token.
  • Sortie : { success: true, link_id, status: "revoked" }.