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.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/vaquill-ai/json-schema/vaquill-ai-comparison-export-schema.json",
"title": "ComparisonExport",
"description": "A short-lived pointer to the rendered comparison.\n\nA URL rather than the bytes: the file is already in object storage, and\nproxying it would put a customer's large DOCX through our request path for\nno benefit. `expiresAt` is absolute rather than a duration, because a\nduration is only meaningful if the client knows when the response was\nproduced.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/vaquill-ai-comparisons-api-openapi.yml#/components/schemas/ComparisonExport",
"properties": {
"format": {
"type": "string",
"enum": [
"redlineDocx",
"redlinePdf"
],
"title": "Format",
"description": "The format that was exported."
},
"url": {
"type": "string",
"title": "Url",
"description": "Short-lived signed URL to download the rendered redline. Fetch it promptly and do not store it."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"title": "Expiresat",
"description": "When the URL stops working (RFC 3339). Absolute rather than a duration, so it is meaningful whenever you read it."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"format",
"url",
"expiresAt"
]
}
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.