VEversionstory
documents

Get Version

A version of a document, by its version_id, or latest for the newest version. files.clean is the document as of that version and, after the first version, files.comparison is its redline against the version before it, each a file as GET /v1/files/{file_id} serves it in the formats asked for. A format still being made is in that file's pending_formats, and the answer carries Retry-After.

get/v1/documents/{document_id}/versions/{version_id}

Request

  • Base URL
    https://api.versionstory.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.versionstory.com/v1/documents/{document_id}/versions/{version_id}
  • Auth
    HTTP bearer

Path parameters

version_idstring required

The version's version_id, a UUID, or "latest" for the Document's newest version.

document_idstring required

The Document's document_id, a UUID.

Query parameters

formatstring[] nullable

The formats of every file the answer carries, each version's file and its redline: docx (default), pdf, md, json, html; repeatable or comma-separated, each as GET /v1/files/{file_id} serves it. A file that is not served in a format asked for lists it in its failed_formats.

inlineboolean

true adds content_base64, the file's bytes, to each ready download of the version's file and its redline.

Headers

X-Customer-Idstring nullable

Id of one of your customers (created in the developer dashboard) to attribute this request's credit usage to. Billing and limits stay organization-wide.

Response

Successful Response

document_idstring required

The Document the version belongs to.

version_idstring required

The version's id.

indexinteger required

The version's position among its Document's versions in the order they were made, counted from 0: the first version, v1, is index 0. It shows the order and names nothing: deleting a version moves the ones after it down, so a request names a version by its version_id.

labelstring required

The app's label for the version, such as v2, or v2(a) for one of competing drafts, which the user names it by. It comes from the version graph, so a sibling added later can relabel it.

namestring required

The version's name, which the app shows: its own once renamed, else its file's.

authorstring nullable

Who its changes are attributed to: an edit's author, an upload's author_name.

descriptionstring nullable

What changed: an edit's description, an upload's description.

created_atstring required

When the version was made: ISO 8601 in UTC, to the second: 2026-10-21T18:22:31Z.

metadataobject

Your own string values by key, stored and returned as they were sent.

Changes

No recorded changes to this operation across all 1 revision of this API.