Skip to main content
GET
Get a document's summary

Authorizations

Authorization
string
header
required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Path Parameters

matterId
string
required

mat_ identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from GET /v1/matters.

documentId
string
required

doc_ identifier of the document. Take it from the matter's document list, or from the operation that completed its upload.

Response

Successful Response

What was persisted the last time this document was summarized.

documentId
string
required

doc_ identifier of the document this summarizes.

Example:

"doc_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

overview
string
required

The whole-document summary, a few paragraphs of prose. Empty string when the summary was stored with sections only.

Example:

"A Master Services Agreement between Acme Corporation and the Supplier, signed 19 August 2026, covering platform implementation and ongoing support for an initial two-year term. Fees are invoiced monthly in arrears and payable within 30 days. Supplier liability is capped at the fees paid in the preceding twelve months, with uncapped carve-outs for confidentiality breaches and third-party IP indemnity. The agreement is governed by Delaware law and either party may terminate for convenience on 90 days' written notice."

documentCategory
string
required

How the summarizer classified the document, for example contract or general. Published as a plain string; do not branch on it without a fallback.

Example:

"contract"

length
string
required

Which length this summary was produced at: short, medium or long. Published as a plain string for the same reason as documentCategory.

Example:

"medium"

createdAt
string<date-time>
required

When the summary was produced (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

sections
SummarySection · object[]

Section-by-section summaries, in document order. Empty when the document was short enough to summarize in one pass.

pageCount
integer | null

Pages the summarizer read. Absent on older rows.

Example:

14

updatedAt
string<date-time> | null

When the summary was last regenerated (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

Last modified on August 23, 2026