OCocrolus
File Commands

Download document

Downloads a <glossary:Document> that has been uploaded to a <glossary:Book>.

📘 Note A regular <glossary:Document> (doc_type=UploadedDoc, the default) cannot be downloaded while its status is FAILED, DELETING, or DELETED. Attempting to do so returns the No Permission error (code 2104).

🚧 Requests to this endpoint will download the requested <glossary:Document> directly to your current working directory, therefore there is no documentation for a JSON response schema for a successful request.

get/v2/document/download

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v2/document/download
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Query parameters

doc_type'UploadedDoc' | 'MixedUploadedDoc'

The type of <glossary:Document> to download. Set to MixedUploadedDoc to download a Mixed Document instead of a regular one.

Response

Success. The Document is returned directly as a file download, so there is no JSON response body.

Changes

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