Sign in
Files

Get preview info for a file by document version

Returns a presigned URL to the PDF preview of a specific document version of the file. The URL is valid for 1 day from the time of the request.

get/matters/{matterId}/documents/files/{fileId}/preview/{documentVersionId}

Path parameters

matterIdstring required

Unique identifier of the matter to which the file belongs.

fileIdstring required

Unique identifier of the file.

documentVersionIdstring required

Unique identifier of the document version to preview, as returned in 'documentVersionId' by CreatePreview or 'versionId' on the file.

Response

When the request is successful. Returns a 'PreviewFileInfo' object.

fileIdstring nullable

Unique identifier of the requested file

documentVersionIdstring nullable

Unique identifier of the document version the preview was generated from. Pass this to GetPreviewById.

downloadUrlstring nullable

Temporary presigned URL to download the PDF preview. Valid for 1 day. Null when the preview has not been generated yet (conversion is pending); poll GetPreviewById until it is available.

expirystring date-time nullable

Expiry date/time (UTC) after which the download link is no longer accessible. Null when the preview has not been generated yet (conversion is pending).

Example response

{
  "fileId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "documentVersionId": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "downloadUrl": "https://bucket.s3.amazonaws.com/previews/accounts/b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2/documents/0f8fad5b-d9cb-469f-a165-70867728950e?X-Amz-Expires=86400&X-Amz-Signature=...",
  "expiry": "2022-04-23T14:30:00Z"
}

Changes

Changed in 1 of the 5 revisions of this API.1

  • db1b8a86b58e1See the full diff
    • ○

      added the optional property errors to the response with the 400 status

      response-optional-property-added