VEversionstory

Get Created Document

Poll the creation job; the created document is its file, as GET /v1/files/{file_id} answers for it.

get/v1/create/{creation_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/create/{creation_id}
  • Auth
    HTTP bearer

Path parameters

creation_idstring required

The creation_id POST /v1/create returned.

Query parameters

formatstring[] nullable

The created file's formats, each as GET /v1/files/{file_id} serves it: docx (default), pdf, md, json, html; repeatable or comma-separated.

inlineboolean

true adds content_base64, the file's bytes, to each ready download in file, 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

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

The creation's status: ready once its DOCX is written. The file's status is that file's: a pdf, md, json or html made from the DOCX afterwards is pending until the file pipeline has made it.

Changes

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