Export formats & their guarantees

/ 01The catalogue

Every export is derived from the same AnalysisResult (see pipeline · output shape). Choose by what the recipient is expected to do with it.

Format	Best for	Editable
DOCX tracked	Drafting in Word	Yes
Branded PDF	Sharing with a partner	No
.fieldbook	Portable record + audit	Yes (in Fieldbook)
Combined DOCX	Single-document handover	Yes
HTML viewer	Email attachment	No
CSV / JSON	Programmatic intake	n/a
iCal	Calendar of deadlines	n/a

/ 02DOCX · tracked changes

The default. Every suggestion becomes a true Word tracked change (w:del + w:ins), with the rule citation in the change comment. Severity is colour-coded in the margin.

POST/redline-docxBody: { "result_id": "an_...", "include_comments": true, "include_obligations": false }. Returns a DOCX stream.

Guarantees

Round-trip safe — accepting the changes in Word produces a document Redline can re-analyse with no loss of structure
Comment thread per issue preserves rule ID and confidence
Obligation matrix optionally appended as an appendix table

What it drops

Document-level metadata not present in the source (analysis ID, run timestamp, jurisdiction) is preserved in custom properties — invisible to most readers but available via w:customProperty.

/ 03Branded PDF

The compliance report. Designed to be the document that goes to the partner. Branded with the firm's logo, cover, palette, and typography.

POST/report/pdfBody: { "result_id": "an_...", "brand_id": "firm_default", "include_appendix": true }. Returns a PDF stream.

Structure

Cover · firm brand · document title · date · authoring associate
Executive summary · score · grade · top three findings
Dimension scores · structure · style · legal · tone
Findings · ordered by severity then confidence
Obligations appendix · table grouped by clause
Methodology · rule pack version · pipeline version · timestamp

The PDF is signed (PAdES-B-T) with the firm's certificate when one is configured; otherwise unsigned. Signature status is rendered on the cover.

/ 04.fieldbook

The portable record. A .fieldbook file (ZIP of SQLite + manifest + audit log) carrying everything: the original document, all findings, the obligation register, and the hash-chained audit. See the anatomy of a .fieldbook file.

POST/export/fieldbookBody: { "result_id": "an_...", "include_obligations": true, "encrypt": true, "password": "..." }

The HTML viewer variant produces a single self-contained HTML file (JSZip + sql.js inlined, base64-embedded data) that opens in any browser offline.

POST/export/fieldbook-htmlReturns a single .html file — emailable, offline-capable, shareable.

/ 05Combined DOCX

The single-document handover. A DOCX that bundles:

The branded report (front matter)
The annotated source document with tracked changes
The findings appendix

Used when you want one file on the desk, with the report on top and the marked-up draft underneath.

POST/export/combined-docxBody identical to /redline-docx; output includes report sections at the top.

/ 06CSV · JSON

Tabular and structured exports for programmatic intake.

GET/export?format=csv&result_id=an_…One row per issue. Columns: id, pass, rule_id, severity, confidence, clause, summary.

GET/export?format=json&result_id=an_…The full AnalysisResult object, suitable for storage or further processing.

/ 07iCal

Deadline-bearing exports — issued by Ledger rather than Review, but listed here for completeness.

GET/api/ledger/v1/calendar.icsVCALENDAR feed; ingestible by Outlook, Google Calendar, Apple Calendar, Fantastical.

See Ledger · iCal calendar feed for the format and signing model.

Export formats & their guarantees.