Get Edit

Wait for an edit that POST /v1/edit reported as processing, and return its download links and version. Pass the edit_id POST /v1/edit returned. Calling it again after a processing answer resumes the wait.

get/v1/edit/{edit_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/edit/{edit_id}
Auth
HTTP bearer

Path parameters

edit_idstring required

The edit_id POST /v1/edit returned.

Query parameters

formatstring[] nullable

The formats of both files, files.clean and files.comparison: docx (default), pdf, md, json, html; repeatable or comma-separated, each as GET /v1/files/{file_id} serves it. md and json are a file's content listing, which the next edit copies its locators from.

inlineboolean

true adds content_base64, the file's bytes, to each ready download in files, so the client needs no second request to the download url.

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

edit_idstring required

status'processing' | 'ready' | 'failed' required

The edit's status; each file's status is that file's.

app_urlstring nullable

Opens the version the edit is kept as at its redline in the Version Story app. Present only with version.

messagestring nullable

Changes

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