Deals

Generate All Deal Documents

Generate all six documents for this deal. SPENDS CREDITS.

ASYNCHRONOUS: the work is queued and this returns straight away. Poll /documents/generation-status.

The app REFUSES this when the deal's company has no completed synthesis documents of its own - the deal documents are written from them, so without them there is nothing to write from. Generate the company documents first.

post/deals/{deal_id}/documents/generate-all

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/deals/{deal_id}/documents/generate-all
  • Auth: HTTP bearer

Path parameters

deal_idstring required

Deal id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataDocumentPayload required

An open envelope for one document, folder or questionnaire.

Open on purpose: a Library document carries extraction metadata, a questionnaire carries per-provider processing detail, and a generated deal document carries structured_data and highlights whose shape is the generator's rather than this contract's. Pinning those would silently drop whatever the app learned to return that this file had not caught up on.

Changes

No recorded changes to this operation across all 2 revisions of this API.