VEversionstory

Get Edit Document

Deprecated: use GET /v1/files/{file_id}?format=json or ?format=md, whose json and md downloads are the file's listing. Kept for the integrations that read it. Answers a file's listing in the body: format=md (the default) as markdown, the md download's text, or format=json as document. status is processing (poll again after Retry-After) until the file is prepared, ready with the listing, or failed with error. In this route's document, level is a numbered paragraph's list level, 1 to 9 as Word's interface counts them; the listing GET /v1/files serves names that list_level. Every index and paragraph id is the one POST /v1/edit and POST /v1/compare/selective name.

get/v1/files/{file_id}/content

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/files/{file_id}/content
  • Auth
    HTTP bearer

Path parameters

file_idstring required

The file to read: the file_id POST /v1/files returned, or a version's file_id.

Query parameters

format'md' | 'json'

md (default): the listing to read and write every edit from. json: the same listing as structured data, for code. Neither is for showing the document to a person: its PDF is, or its HTML where the view must be interactive.

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

file_idstring required
status'processing' | 'ready' | 'failed' required
markdownstring nullable

Present when ready with format=md (the default).

Changes

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