Get Merge
Return a merged document's download links once it has generated.
Returns the merge POST /v1/merge staged, by merge_id, in each format asked for: docx (the default), pdf, or md (its tracked changes as text). Merging first compares each revision with the base and then folds those redlines together, so the call may return status processing several times: calling again with the same merge_id keeps waiting, and several minutes is normal. A status of failed is terminal. When ready, each file.downloads[] entry carries the url of one format, a link that serves the file directly: save each file from it, or give it to the user when the client cannot download files itself. The links expire after one hour.
To read the merge's changes, as when the user asks what changed, read the md entry of file.downloads[].
Request
- Base URLhttps://api.versionstory.com (the document declares no server; this is the origin it was published from)
- URLhttps://api.versionstory.com/v1/merge/{merge_id}
- AuthHTTP bearer
Path parameters
The merge_id POST /v1/merge returned.
Query parameters
docx (default), pdf, md, json; one or more. pdf is the document to show a person. docx is the Word file with tracked changes, for a lawyer to review and send on. md is the text with the changes marked, for a model to read. json is the same as structured data, for code to act on (counting the changes, routing the document, linking a change to a record). It describes the document's structure and changes, not its layout in pages, so never draw the document from it: show the PDF.
Headers
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
Changes
No recorded changes to this operation across all 1 revision of this API.