Getting started · the first reading

/ 01What Redline does

Redline Review is a contract-reading engine. You give it a document and a jurisdiction; it gives you back issues — each one with the rule that fired, the input that triggered it, and the confidence assigned. No black-box verdicts.

Four kinds of reading happen in the same run:

Structural — the grammar, readability, and shape of the document
Stylistic — citations, numbering, term consistency against a guide
Substantive — internal contradictions, definition scope, cross-reference integrity
Legal — 847+ rules across 127 jurisdictions, applied to the jurisdiction you name

The full mechanism is the subject of the eight-pass pipeline. For now: hand it a document.

/ 02Inputs: text, tier, jurisdiction

A first run needs three things and three things only.

textrequired
The document body. UTF-8. Minimum 10 characters. You can also POST a DOCX to /api/v1/analyse-docx and the engine will extract canonical text first.
tierA · B · C
A is free and runs Structural · Style · Synthesis. B adds Legal pack and Consistency. C adds Semantic, counterparty, and autopilot.
jurisdictionrequired for B/C
One of 127 codes. The most common: eng, sco, de, fr, us_ny, us_de, eu, sg, hk, au, ae_difc.

/ 03Running the analysis

Two ways: through the web SPA at /, or via the API:

curl -X POST https://engine.parelion.local:8765/api/v1/analyse \
  -H "X-Redline-Key: \$REDLINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "1. The Provider shall...",
    "tier": "B",
    "jurisdiction": "eng",
    "enable_legal": true,
    "style_guide": "legal"
  }'

The default endpoint blocks for the duration of the analysis (≤60s). For long documents, use the streaming endpoint:

POST/api/v1/analyse/streamServer-Sent Events stream of per-pass progress, ending with the full AnalysisResult.

/ 04Reading the result

Every response carries the same shape regardless of tier — fields populated only by higher tiers are present but empty.

The four numbers to read first

A–FLetter grade

0–100Composite score

4Dimension scores

nIssues by severity

Then walk the issues array. Each issue carries a severity (critical · major · minor · suggestion), a confidence, the offending span, and a suggestion when one applies.

The keyboard, in the web SPA

j / k — next / previous issue
a / d — accept / dismiss the current issue
n / p — next / previous sentence in the document

/ 05Where to read next

If the result surfaced a legal-pack issue you disagree with — how to author a rule describes the schema and how to override or extend the corpus.

If you want the result in Word, with tracked changes — export formats and their guarantees covers the catalogue.

If you want this in your team's drafting workflow — Word add-in installation & SSO.

The first reading.