Skip to main content
Get a link to download a document

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

format
enum<string>
default:original

original is the uploaded file. text is its extracted text as Markdown; a CSV, TSV or plain-text file is its own text.

Available options:
original,
text
strategy
enum<string>

With format=text: the text from this extraction strategy. Omit for the best available text.

Available options:
ocr,
deterministic

Response

The link, its expiry and a file name. origin is extracted when the link gives extracted text, which also names the strategy that produced it.

source_version
string
required
strategy
enum<string>
required
Available options:
ocr,
deterministic
verification
object
required
download_url
string<uri>
required
expires_at
string<date-time>
required
content_type
enum<string>
required
Available options:
text/markdown
origin
enum<string>
required
Available options:
extracted
file_name
string
required