Skip to main content
POST
Export a reviewed contract with redlines applied

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.

reviewId
string
required

rev_ identifier of the contract review. Returned on the operation that launched it, at either depth.

Body

application/json

Which of a review's redlines to apply, and how to mark them up.

Omitting redlines applies EVERY redline the review produced, which is the common case for an integration that has already triaged them elsewhere. Supplying them is how a caller applies a subset, or applies edits it wrote itself after reading the review.

redlines
AcceptedRedline · object[] | null

Which edits to apply. Omit to apply EVERY redline the review produced, which is the common case for an integration that triaged them elsewhere. Supply them to apply a subset, or edits you wrote yourself.

Maximum array length: 500
trackedChanges
boolean
default:true

True renders native Word tracked changes, so the counterparty accepts or rejects each edit in the Review pane. False renders colored strikethrough and underline, which is viewable anywhere but is not real revisions.

Example:

true

Response

Successful Response

A short-lived URL to the marked-up contract.

The same shape as a comparison export, and for the same reason: the route declares a response model, and a DOCX is not one. The bytes live in object storage and the customer fetches them directly.

approvalGate is repeated here rather than left on the review. An integration that exports without re-reading the review is exactly the one that would send an unapproved redline to a counterparty, and the gate is cheap to carry at the point where content actually leaves the workspace.

filename
string
required

Suggested filename for the download.

Example:

"msa-acme-v3.docx"

url
string
required

Short-lived signed URL to download the marked-up contract. Fetch it promptly and do not store it.

Example:

"https://storage.vaquill.ai/exports/msa-acme-v3-redline.docx?signature=..."

expiresAt
string<date-time>
required

When the URL stops working (RFC 3339).

Example:

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

sizeBytes
integer
required

Size of the exported file in bytes.

Example:

248193

redlineCount
integer
required

How many redlines were applied to produce this file.

Example:

9

trackedChanges
boolean
required

Whether the export uses native Word tracked changes.

Example:

false

format
string
default:docx

Format of the exported file. Only DOCX is produced today.

Allowed value: "docx"
Example:

"docx"

approvalGate
ReviewApprovalGate · object | null

Repeated from the review on purpose. An integration that exports without re-reading the review is exactly the one that would send an unapproved redline to a counterparty, so the gate travels with the bytes.

Last modified on August 23, 2026