Skip to main content
POST
Export a comparison

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.

comparisonId
string
required

cmp_ identifier of the comparison. Returned on the operation that launched it.

Body

application/json

Ask for a pointer to a rendered redline the worker already produced.

format
enum<string>
required

Which rendered artifact to link to. Both are written by the comparison worker, so this returns a pointer rather than triggering a render.

Available options:
redlineDocx,
redlinePdf
Example:

"redlineDocx"

Response

Successful Response

A short-lived pointer to the rendered comparison.

A URL rather than the bytes: the file is already in object storage, and proxying it would put a customer's large DOCX through our request path for no benefit. expiresAt is absolute rather than a duration, because a duration is only meaningful if the client knows when the response was produced.

format
enum<string>
required

The format that was exported.

Available options:
redlineDocx,
redlinePdf
Example:

"redlineDocx"

url
string
required

Short-lived signed URL to download the rendered redline. 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). Absolute rather than a duration, so it is meaningful whenever you read it.

Example:

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

Last modified on August 23, 2026