Deals

Get Deal Document Generation Status

How the generation is going - the cheap read to POLL.

Counts rather than content: total, ready, generating, failed. Listing the documents transfers every body, which is the wrong call in a poll loop.

get/deals/{deal_id}/documents/generation-status

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/deals/{deal_id}/documents/generation-status
  • 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.