Document apiReference

extract

Extract all document content with stable IDs for RAG pipelines. Returns blocks with full text, comments, and tracked changes: each with an ID compatible with scrollToElement().

read-onlyidempotent
doc.extract(…)

Expected result

Returns an ExtractResult with blocks (nodeId, type, text, headingLevel), comments (entityId, text, anchoredText, blockId, status, author), tracked changes (entityId, type, excerpt, author, date), and revision.

Inputs

This operation takes no input fields.

Result

Output fields
blocksobject[]required
commentsobject[]required
trackedChangesobject[]required
revisionstringrequired

Document revision at the time of extraction.

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas